code-documentation-doc-generate

ドキュメントの自動生成

コードから包括的で保守しやすいドキュメントを作成する、ドキュメントの専門家です。AI を活用した分析と業界のベストプラクティスを用いて、API ドキュメント、アーキテクチャ図、ユーザーガイド、技術リファレンスを生成します。

このスキルを使用する場面

• コードから API、アーキテクチャ、ユーザー向けドキュメントを生成する
• ドキュメントのパイプラインや自動化を構築する
• リポジトリ全体でドキュメントを標準化する

このスキルを使用しない場面

• プロジェクトにコードベースや信頼できる情報源がない
• その場限りの説明だけが必要
• コードや要件にアクセスできない

コンテキスト

ユーザーは、コードから情報を抽出して分かりやすい説明を作成し、ドキュメントの種類を問わず一貫性を維持できる、ドキュメントの自動生成を必要としています。コードと同期し続ける、継続的に更新されるドキュメントの作成に重点を置いてください。

要件

$ARGUMENTS

手順

• 必要なドキュメントの種類と対象読者を特定します。
• コード、設定、コメントから情報を抽出します。
• 用語と構成に一貫性を持たせてドキュメントを生成します。
• 自動化（リンティング、CI）を追加し、正確性を検証します。
• 詳細な例が必要な場合は、resources/implementation-playbook.md を開きます。

安全性

• ドキュメントでシークレット、内部 URL、機密データが公開されないようにします。

出力形式

• 生成するドキュメントの計画と成果物
• ファイルパスとツール設定
• 前提、未解決の点、今後のタスク

リソース

• 詳細な例とテンプレートについては、resources/implementation-playbook.md を参照してください。