ドキュメント自動化
GitHubソース、ドキュメント種別、更新方式を選択して、コードに基づくドキュメントプロジェクトを作成します。
ドキュメントプロジェクトは、ワークスペースのフォルダにGitHubリポジトリを接続し、エージェントがコードに基づくドキュメントを生成して同期状態を維持できるようにする単位です。
始める前に
- ワークスペースにGitHubが接続されている必要があります。
- 編集者、管理者、またはオーナーの権限が必要です。閲覧者の権限ではドキュメントプロジェクトを作成できません。
- ドキュメントプロジェクトはプロ・マックス・チーム・エンタープライズプランで利用できます。無料プランの場合は料金プランを確認してください。
プロジェクトを作成する
サイドバーの新規（+）→ プロジェクトを作成を押すと、ドキュメントプロジェクトの設定タブが開きます。ウィザードはソースとドキュメントの2ステップで進み、生成を開始する前にGitHubソース、ドキュメント種別、更新方式を決めます。
ソース — どのコードベースをドキュメント化しますか？
GitHub アカウント、リポジトリ、ブランチを選択します。リポジトリは名前で検索できます。リポジトリとブランチの両方を選択すると、右上の次へが有効になります。
ドキュメント — 何から作成しますか？
エージェントが最初に作成するドキュメントスキルを1つ以上選択します。インストール済みのドキュメントスキルがない場合は、マーケットプレイスで探すまたは新規作成を使います。スキルごとに実行手順を見るで、どのドキュメントをどのように書くかを確認できます。
重視する点 — 任意
同じステップの**今回の生成で重視する点 (任意)**に、今回の生成にだけ適用するリクエストを書きます。ドキュメントの読者、強調したい内容、希望する詳しさを具体的に書くほど、よい結果が得られます。
更新方式 — コードが変わったらどうしますか？
リポジトリの変更を自動反映をオンにすると、選択したブランチにコードが反映されたときに、ドキュメントを最新の状態に更新します。準備ができたらドキュメントN種を作成を押して生成を開始します。
選択したドキュメントの一部が全体再生成方式の場合、コード変更時には増分更新のドキュメントだけが自動で更新されます。全体再生成のドキュメントは手動で再生成する必要があります。
生成中に行われること
生成を開始すると、Specifyは次の準備を行います。
- プロジェクトインデックス — フォルダ、プロジェクトのレコード、生成タスクを結び付け、以降の更新が同じプロジェクトに紐付くようにします。
- 自動更新の準備 — 生成されたドキュメントが変更の提案を受け取れるように、選択した自動化モードを先に保存します。
- 変更レビューの基盤 — 生成されたページにソースへのリンクを残し、以降のリポジトリの変更を根拠とともにレビューできるようにします。
生成画面を閉じても、インボックスがタスクを引き続き追跡します。ドキュメントごとの生成状態は、開始待ち、作成中、完了、失敗、開始不可で表示されます。
エージェントが質問してきたとき
ドキュメントを書くために必要な情報が足りない場合、エージェントが質問して回答を待ちます。スレッドを開いて回答すると、生成が再開されます。
生成が完了しなかったとき
プロジェクトは作成されたものの最初のドキュメントの生成が完了しなかった場合は、生成の確認が必要ですと表示されます。表示された理由を確認してから、次のいずれかを選択します。
- 再試行 — 同じ設定で生成をやり直します。
- ソースを変更 — リポジトリやブランチを変更してやり直します。
- 閉じて通知を受け取る — インボックスで結果の確認を続けます。
タスクの上限に達して一部のドキュメントタスクが開始されなかった場合は、予算とプロジェクトの権限を確認し、実行中のドキュメントタスクが終わってから再度生成してください。
ドキュメントを追加する
最初の実行の後、同じプロジェクトフォルダに別のガイドやリファレンスを追加で生成できます。プロジェクト一覧でプロジェクトを選択し、ドキュメントの追加を実行します。