ドキュメント自動化

自動化の詳細設定

pushトリガー、作成スキル、出力フォルダ、プロジェクトのスタイルガイドでドキュメント自動化を調整します。

ドキュメントプロジェクトの自動化の詳細設定では、接続されたリポジトリ、ドキュメントの更新方式、作成の既定値を管理します。プロジェクト設定は、基本、ソース、自動化、文書作成の項目に分かれています。

リポジトリとpushトリガー

ソース項目で、ドキュメントの根拠として使うリポジトリとブランチを接続します。ソースごとにpush で実行をオンにすると、そのブランチにコードをpushしたときにもドキュメントの修正案を用意します。

デフォルトブランチ（例：main）でのみpushトリガーをオンにしておくと、作業中のブランチの変更が修正案に混ざりません。

作成スキルは、エージェントがドキュメントを生成するときに従う作成規律です。ドキュメント種別に合ったスキルを選び、必要に応じて補助スキルを追加します。補助スキルは最大5個まで選択できます。

生成されたドキュメントを保存するフォルダを選択します。選択しない場合は、現在のプロジェクトフォルダに保存されます。

このプロジェクトのドキュメントに適用するMarkdownのルールを書きます。ワークスペースのスタイルガイドより具体的なため、競合した場合はプロジェクトのスタイルガイドが優先されます。空欄の場合は、ワークスペースのガイドのみが適用されます。

プロジェクトのスタイルガイドの例

## 文体
- 表よりも文章で書きます
- 各セクションに担当チームを明記します
 
## 用語
- 「ユーザー」ではなく「顧客」と書きます
- API名はコード表記（`like_this`）で書きます

修正案を自動で反映するかどうかは、プロジェクト設定とワークスペースに適用されたポリシーに従います。新しいプロジェクトは自動反映なしで始まり、自動反映が許可されている場合は、低リスクの変更が自動で承認されることがあります。レビューの流れは修正案のレビューと反映を参照してください。