タグ

ドキュメントに関するYassLabのブックマーク (6)

  • 賢い質問のしかた

    翻訳: アラビア語 インドネシア語 ベラルーシ語 ブラジルポルトガル語 中国語 チェコ語 オランダ語 フランス語 グルジア語 ドイツ語 ギリシャ語 ヘブライ語 ポーランド語 ポルトガル語 ルーマニア語 ロシア語 セルビア語 スペイン語 スウェーデン語 タイ語 If you want to copy, mirror, translate, or excerpt this document, please see my copying policy. 多くのプロジェクトのウェブサイトがヘルプの項目からこのドキュメントにリンクを張っている。それは私達の意図した使い方なので構わない ―― しかしあなたがそのようなリンクをプロジェクトのページに追加しようとしているウェブ管理者ならば、リンクの傍らに目立つように、私達があなたのプロジェクトのサポート窓口ではないことを明示してほしい。 その注意書き無くし

    YassLab
    YassLab 2023/10/30
    “技術的な質問に返ってくる答えの質は、回答の難しさだけではなく聞き方次第でもある。この手引きはあなたがより満足する回答を得られるような質問のしかたについて述べている。”
  • Railsの設計に迷ったのでGitLabの設計ドキュメントを読んでみた | DevelopersIO

    Railsプロジェクトがそこそこ大きくなり、ServiceやSerializerなどのカスタムレイヤーを追加してコードを細分化しているものの、レイヤーの役割やインターフェイスのルールが明確に決まっておらずふわふわとしていることを課題と感じていました。課題を解決するヒントを探すため、Railsの超巨大OSSプロジェクトであるGitLabの設計ドキュメントを読んでみました。 ガイドラインの必要性 まず初めにガイドラインの必要性が語られています。レイヤーの抽象化ができたとしても、それを正しく使えないと、あっという間にメンテナンスしにくいコードができてしまうということが説明されています。 例として、あるFinder(Finderはデータベースからデータを検索する抽象)の中で別のFinderを呼び出してはいけないということが挙げられています。もしそうしたなら、Finderにどんどんオプションが追加

    Railsの設計に迷ったのでGitLabの設計ドキュメントを読んでみた | DevelopersIO
    YassLab
    YassLab 2023/07/12
    “Railsの超巨大OSSプロジェクトであるGitLabの設計ドキュメント / ServiceはRailsではお馴染みのレイヤーですが、その役割は様々な印象です。GitLabでは、Serviceは「アプリケーションの状態に変化を加えるもの」と定義している”
  • 話題の ChatGPT + LangChain で、膨大な PDF ドキュメントの内容を爆速で把握する - Qiita

    はじめに 記事では、ChatGPT と LangChain の API を使用して、PDF ドキュメントの内容を自然言語で問い合わせる方法を紹介します。 具体的には、PDF ドキュメントに対して自然言語で問い合わせをすると、自然言語で結果が返ってくる、というものです。 ChatGPT と LangChain を使用することで、下記のような複数ステップの仕事を非常に簡単に実行させることができます。 PDF ドキュメントからテキストを抽出して複数に分割する 分割したテキストからテキスト間の関連を表すベクターデータを作成する 作成したベクターデータをベクターストアに格納しておく ChatGPT に外部から与えたベクターストアを使って問い合わせに答えるようにさせる これにより、大量の PDF ファイルを自動的に解析し、必要な情報を素早く抽出できるようになります。 記事では、ChatGPT

    話題の ChatGPT + LangChain で、膨大な PDF ドキュメントの内容を爆速で把握する - Qiita
    YassLab
    YassLab 2023/04/23
    “本記事では、ChatGPT と LangChain の API を使用して、PDF ドキュメントの内容を自然言語で問い合わせる方法を紹介 / 具体的には、PDF ドキュメントに対して自然言語で問い合わせをすると、自然言語で結果が返ってくる”
  • ITエンジニア向けのトレンド情報 | Forkwell Press (フォークウェルプレス)

    アーカイブでは視聴者からのQ&Aを見ることができます ドキュメント文化を浸透させる方法 おすすめのドキュメント管理ツール ドキュメントがない状態での引き継ぎ 運用しやすいドキュメント構造とは 増えすぎたドキュメントの管理方法 ドキュメントを残さないシニアエンジニアへの対策 ドキュメントへの苦手意識を克服する方法 誰もドキュメントを読んでくれません 複数人でドキュメント管理するコツ 記事のTopics 書籍の概要・構成 おすすめの書籍 読み手の理解 ドラフトの執筆 フィードバックの収集と組み込み ドキュメントの品質測定 日語を学べる書籍 ドキュメントは開発側の生産性とユーザーの利便性を高めるもの。ドキュメントがなければ、ユーザーに使われる機会が確実に減ります。開発者がいかにすばらしいプロダクトを作ろうが、ドキュメントの欠如がその価値を奪うのです。 書は、経験に長けた執筆者たちがドキュメ

    ITエンジニア向けのトレンド情報 | Forkwell Press (フォークウェルプレス)
    YassLab
    YassLab 2023/04/20
    “今までのエンジニア人生で最高のドキュメントは? Ruby on Rails ガイドはよかった”
  • あーありがち - 2018年にもなってMiddlemanとJekyllを比較してみたよ

    Jekyll • Simple, blog-aware, static sites | Transform your plain text into static websites and blogsMiddleman: Hand-crafted frontend development先に結論独自に拡張していく、外部のデータと連携することを重視するなら Jekyll の方がよさそう。 Rails の view に慣れてて何も設定せずにいきなり使う場合の初速の速さは Middleman の方が上になる。 きっかけ2016 年に『マイクロサービスアーキテクチャ』を読み、それとは別に Decoupled CMS という概念を知って以来、古くて評判のよくない CMS を使うことや自分で中途半端な CMS もどきを作ることに対して今まで以上に「このままじゃいかんよな」と思うことが増えていて、改めて

    YassLab
    YassLab 2023/04/07
    "ERBとMiddleman標準のasset digestにこだわる必要がないならJekyllの方がよさそう。特にDecoupled CMSやモダンフロントエンドなど、外部とどう組み合わせるかという点を重視した際の拡張しやすさはJekyllの方に軍配が上がると思う"
  • まつもとゆきひろさん「価値を生み続けるための鍵はコミュニティ —Contribute to Ruby—」 ~RubyKaigi 2022 2日目キーノート | gihyo.jp

    RubyKaigi 2022 キーノートレポート まつもとゆきひろさん「価値を生み続けるための鍵はコミュニティ —Contribute to Ruby—」 ~RubyKaigi 2022 2日目キーノート 2022年9月8日から10日までRubyKaigi 2022が開催されました。2日目の基調講演では、Rubyの作者であるまつもとゆきひろさんが登壇し、「⁠Contribute to Ruby」というタイトルで発表しました。 この講演では、Rubyの価値とRubyに関わる人々に期待するコントリビューションについて話しました。 Rubyの価値 まつもとさんがRubyを公開してから現在に至るまで、Rubyに対してさまざまな意見が寄せられ、批判的な意見もたくさんあったと言います。紹介されたいくつかの意見の中には、Rubyの存在自体を否定する意見もありました。 では、Rubyは存在する価値がないの

    まつもとゆきひろさん「価値を生み続けるための鍵はコミュニティ —Contribute to Ruby—」 ~RubyKaigi 2022 2日目キーノート | gihyo.jp
    YassLab
    YassLab 2022/10/12
    “7つ目は翻訳です。ドキュメントの翻訳が十分ではないとのことです。英語のドキュメントを読めば良いというのは1つのポリシーではあるものの、可能であれば多くの方が母語でドキュメントを読めることが望ましい”
  • 1