documentation-generator

ドキュメント生成ツール

目的と意図

documentation-generator は、ソースコードから技術ドキュメントを自動的に作成・更新することで、ソフトウェアプロジェクトの保守性を維持します。

使用するタイミング

• 開発後：機能の実装が完了した後に実行し、API ドキュメントを最新の状態に保ちます。
• オンボーディング：新しいチームメンバー向けに、アーキテクチャ図や概要を生成するために使用します。

使用しないタイミング

• 上位レベルの戦略：このツールは技術ドキュメントを生成するものであり、「ビジネス要件」や「製品ビジョン」のドキュメントは作成できません。

セキュリティとデータの取り扱いに関する考慮事項

• ローカルで動作し、ソースコードを外部サーバーにアップロードしません。