本文へスキップ
SpecifyDocs

ドキュメント自動化

コードから文書・設計図を作る

リポジトリを読み、機能文書とアーキテクチャキャンバスを作成して根拠を確認します。

SpecifyはGitHubのコードから機能ドキュメントやアーキテクチャのキャンバスを作成します。作成したコンテンツにリポジトリを接続すると、その後の変更も反映できます。必要な成果物を作り、それぞれに自動更新を接続してください。

始める前に

GitHubを接続し、対象のリポジトリにアプリがアクセスできることを確認します。保存先のワークスペースとフォルダーも決めます。

最初の文書と設計図を作る

  1. チャットでリポジトリを選ぶか、@で指定します。
  2. 機能、読者、出力形式を具体的に依頼します。主要なフローから始め、必要な範囲に広げていきます。
  3. エージェントがコードを調べて文書やキャンバスを保存したら、結果を開きます。追加の質問には同じ会話で回答します。
このリポジトリのログインフローをコードで確認してください。
入口、認証処理、データ保存、エラー処理を説明する文書と、
構成要素の関係を示すアーキテクチャの設計図を作成してください。
確認できなかった点は分けて記載してください。
Mammaの実際のコードから作成したプロジェクト概要
文書でコードの根拠と主要な構成要素を確認します。

保存された結果を確認する

文書の説明とコードの根拠を照合します。設計図は構成要素、接続の方向、外部依存を確認してください。実行が完了したら保存された内容を確認し、不足部分は同じ会話で補足を依頼します。

Mammaの構成要素とデータフローを示すアーキテクチャキャンバス
設計図で依存関係とデータフローをレビューします。

自動更新を接続する

各文書・キャンバスの接続 → 接続を管理 → イベント連携でリポジトリにチェックします。接続したデフォルトブランチへの次のpushから変更を分析し、そのコンテンツを直接更新します。文書と設計図の両方を維持する場合は、それぞれ接続します。

Mammaのdevelopブランチと接続済み状態を示すコンテンツ接続画面
文書・キャンバスごとにリポジトリ接続と対象ブランチを確認します。

文書を増やす

同じリポジトリからAPI説明、オンボーディングガイド、運用手順などを追加で依頼し、フォルダーで整理します。再利用する執筆指示はスキルで管理できます。更新後は結果を確認してください。