mkuri.dev

LLMを使ったソフトウェア開発時のドキュメント構成テンプレート

概要

LLM(Large Language Model)を使ったソフトウェア開発プロジェクトにおいて、効率的で保守性の高いドキュメント構成のテンプレートについてまとめます。

ドキュメント構成

ファイル構成

  • docs/

    • overview/

      • project-brief.md: プロジェクトの背景、目的

    • development/

      • design-document.md: システム設計、技術選定理由

      • progress.md: 要件、進捗、課題

      • contribution.md: 開発環境、コーディング規約、PR規約、レビュープロセス

    • README.md: ドキュメント全体の概要、ナビゲーション

運用方針

  • 各LLMの文脈保持のためのmdはdocs内のmdを参照

  • プロジェクト固有の知識はdocsディレクトリに集約

  • 開発履歴と文脈の永続化を重視

自動化

(ここに今回ドキュメント構成を初期化するための仕組みを記載予定)

まとめ

LLMを利用した開発プロジェクトでは、LLMに適切に文脈を伝えるドキュメント構成が重要です。またこれらのドキュメントは人間に対しても有用です。

プロジェクト固有の知識を体系的に管理するための最小限のドキュメントテンプレートを整理しました。

リファレンス

LLM開発ツールのドキュメント構成

デザインドキュメントとアーキテクチャ