documentation-production

ドキュメントの作成

概要

焦点を絞ったドキュメント、インデックス、図、チュートリアル、学習パスなど、さまざまな形式のドキュメントを一貫した手間の少ないワークフローで作成します。出力を構造化し、リポジトリのドキュメント規約に沿わせます。

使用する場面

• コンポーネント、API、機能に関するドキュメントを生成または更新する
• プロジェクトのインデックスやナレッジベースを作成する
• システムの動作やアーキテクチャを示す Mermaid 図を作成する
• チュートリアル、ワークショップ、学習パスを作成する
• オンボーディングや教育のために概念を説明する

次の場合は使用しないでください：

• 依頼の主な目的がコード変更である（実装ワークフローを使用してください）
• 構造化する必要のない単発のメモである

クイックリファレンス

タスク	読み込むリファレンス
焦点を絞ったドキュメントを生成する	skills/documentation-production/references/generate.md
プロジェクトのインデックス／ナレッジベース	skills/documentation-production/references/index.md
Mermaid 図	skills/documentation-production/references/diagrams.md
概念や学習パスを教える	skills/documentation-production/references/teacher.md
チュートリアル／ワークショップ	skills/documentation-production/references/tutorials.md
執筆のプロセスとスタイル	skills/documentation-production/references/writing-process.md

ワークフロー

1. ドキュメントの種類と対象読者を特定します。
2. 構成やパターンを確認するため、関連するリファレンスファイルを読み込みます。
3. コードや既存のドキュメントから情報を収集します。
4. 指定された形式で成果物を作成します。
5. 正確性とリポジトリの規約との一貫性を検証します。
6. 変更内容と次のステップを要約します。

出力

• ドキュメントの成果物
• 簡潔な変更概要と、フォローアップが必要な不足事項

よくある間違い

• ソースを確認せず、動作を推測してしまう
• 明確な意図なく、チュートリアルとガイドの形式を混在させる
• ラベルやアクセシビリティに関する注記を付けずに図を作成する
• インデックスやナビゲーションリンクを調整せずにドキュメントを更新する