Upgrade to Pro — share decks privately, control downloads, hide ads and more …

Devinを導入してドキュメンテーションで変わったこと

nogawanogawa
April 15, 2025
19

 Devinを導入してドキュメンテーションで変わったこと

nogawanogawa

April 15, 2025
Tweet

Transcript

  1. © 2025 Wantedly, Inc. 自己紹介 - 角川拓也 - X: @nogawanogawa

    - 所属 - ウォンテッドリー株式会社 データサイエンティスト - ex. - ITコンサル @コンサル会社 - システムエンジニア @金融系SIer
  2. © 2025 Wantedly, Inc. Devin - AI software engineer -

    指示を出すとコード書いてくれて PRまで作ってくれる - 自動でPR作成まで完結する - ドキュメンテーション関連の機能も非常に便利( ←今日はこれに関する話) - Devin Wiki - Devin Search
  3. © 2025 Wantedly, Inc. - Devin Wiki - リポジトリ連携 ・ワークスペースの設定

    するだけでとてもリッチなドキュメントを 作ってくれる Devin
  4. © 2025 Wantedly, Inc. - Devin Search - コードベースに関して 対話的に質問できる

    - 日本語で知りたいことを聞けば、図解や該当コード箇所まで示してくれる Devin
  5. © 2025 Wantedly, Inc. ドキュメンテーションの観点で考え直す • Devinに限らずAI コーディングツールを使えば READMEの更新などはほぼ自動でできる ◦

    実際に生成されたドキュメントで内部仕様は特に不自由なく理解できる • 本当にそれが全て? ◦ そんなことない ◦ 例として、Devinの設定をする際に追加でKnowledgeを設定できるようになっている ▪ コードを読めばわかる情報は自動生成で良さそう • Devin Wiki, Searchもその延長線 ▪ Agentが効果的に動作するためにあえて Knowledgeを追加設定させている • 効果的にAI Agentを使うためにも、コードだけでわからないことはまだまだ人間が書く 必要があるのでは?
  6. © 2025 Wantedly, Inc. 書き手の視点で人間がやらないといけないドキュメンテーション 人間 AI 人間 AI 書き手

    読み手 自動生成ドキュメント (例: Devin Wiki) コードから得た知識 (例: Knowledge) コードから読み取れない情報 例: 外部仕様, 変更の歴史 例:コードベースに 関する規約・開発フロー AIエージェントの有効活 用のためにも、 コードに残らない情報は 人間が用意しないとダメ そう 人間の理解のために コードに書いてある仕様 を文字におこすのは自動 化で良さそう
  7. © 2025 Wantedly, Inc. どちらの読み手のための 情報であっても、 AI Friendlyな形式(*)で 残していったほうが良さ そう

    読み手の視点で人間がやらないといけないドキュメンテーション 人間 AI 人間 AI 書き手 読み手 人間だけでなくAIも読み やすい形式であることが 望ましい (対話的に情報にアクセ スしたりするので) AIが読みやすい形式で あることが望ましい *: https://ai-native-development.gitbook.io/docs/ja/collaboration/ai-friendly-documentation
  8. © 2025 Wantedly, Inc. • Devinなど、AIコーディングツールは ドキュメンテーションの視点でも興味深い ◦ 設定するだけでリッチなドキュメントが生成され、対話的に情報にアクセス可能 ◦

    Devinに限らず、AI コーディングツール等を使用すれば内部仕様は自動生成できる時代 • この状況を踏まえて ドキュメンテーションに対して考えることが変わった ◦ 人間に必要なドキュメンテーションの Why/What/Howはこんな感じではなかろうか? ▪ Why(なぜ): コードだけでは汲み取れない情報があり、その情報を人間も AIも使う ▪ What(何を): コードに残らない情報 ▪ How(どう残すか): AI Agentが扱いやすいAI Friendlyな書き方 まとめ