ダイナミックドキュメント

「ドキュメント」タブ内にて、チャットを行うことなく自動でプロジェクト概要やモジュール情報などを生成することが可能です

１ 生成および結果の確認

<aside> 💡

本機能リリース前にインポートしたプロジェクトにおいても生成が可能です

</aside>

<aside> 💡

コードが更新された際のダイナミックドキュメントの更新機能は今後ご提供予定となっており、現時点ではご利用頂けません

</aside>

1）生成の実行

❶「ドキュメント」タブへ移動し、上部「ダイナミックドキュメント」エリアのフォルダ名をクリックの上、「生成する」ボタンを押下します

※反映前の下書きドキュメントが存在する場合、押下が出来ませんので、下書きの反映(または取り消し)後に実施してください

image.png

2）生成結果の確認

以下のようなファイル/フォルダが生成されます

名称 種別 説明
概要 ファイル プロジェクトの概要を解析した結果になります
機能一覧 ファイル 主な機能が表形式で出力されます
セットアップ ファイル デプロイ手順などの解析結果が出力されます
モジュール フォルダ 配下にモジュールごとのフォルダが作成され、モジュール概要やAPI仕様、モジュール内の各機能仕様などのドキュメントが出力されます
ルール フォルダ フレームワーク、リンティング、構造などの解析結果が出力されます

<aside> 💡

生成されるドキュメントの量はプロジェクトによって動的に変化いたします

</aside>

image.png

<aside> 💡

現在、ダイナミックドキュメントについては、一部Mermaidのエラー等が発生するケースがあることから編集を許可しております。今後、コードの変更に伴うダイナミックドキュメントの更新機能がリリースされる際には、エラーの防止策のご提供とともに、ダイナミックドキュメントエリアのファイルは編集不可となる予定です

</aside>

2）生成結果のエクスポート

ドキュメント機能 にて作成した他のドキュメントと同様、.md .pdf 等でのダウンロードが可能です

image.png