AutoGenCodeDocsは、プロジェクト内の全てのコードファイルを探査し、ローカルLLMを用いてそれぞれのコードファイルに関するドキュメントとサマリーを生成するツールです。この自動化されたプロセスにより、プロジェクトの構造を明らかにし、メンテナンスや理解を容易にします。
- コード探査: プロジェクトディレクトリ内の全てのコードファイルを自動的に識別し分析します。
- ドキュメント生成: 各コードファイルの機能と役割についての詳細なドキュメントを生成します。
- サマリー作成: ピラミッド方式により、プロジェクト全体の概要を段階的に構築します。
# クローンする
git clone https://github.com/MakeNoah/AutoGenCodeDocs.git
# ディレクトリに移動
cd AutoGenCodeDocs
# スクリプトを実行
python autogencodedocs.py貢献方法 AutoGenCodeDocsはオープンソースプロジェクトであり、コミュニティの貢献を歓迎しています。バグ報告、機能の提案、ドキュメントの改善などについては、GitHubのissueやpull requestを通じて貢献してください。