documentation

ドキュメントワークフローバンドル

概要

コードベースから API ドキュメント、アーキテクチャドキュメント、README ファイル、コードコメント、技術コンテンツを生成するための包括的なドキュメントワークフローです。

このワークフローを使用する場面

次の場合にこのワークフローを使用します：

• プロジェクトのドキュメントを作成する
• API ドキュメントを生成する
• アーキテクチャドキュメントを作成する
• コードをドキュメント化する
• ユーザーガイドを作成する
• Wiki を保守する

範囲

リクエストに必要なフェーズのみを選択してください。このバンドルは、参照されているすべてのスキルや外部公開を許可するものではありません。呼び出す前に、各 ID とローカルの前提条件を確認してください。既存のドキュメントを保持し、提案された決定と承認済みの決定を区別し、公開用の例に非公開データを含めないようにし、プロジェクトで実際に使用されているドキュメントチェックを実行してください。

ワークフローフェーズ

フェーズ 1：ドキュメントの計画

呼び出すスキル

• docs-architect - ドキュメントアーキテクチャ
• documentation-templates - ドキュメントテンプレート

アクション

1. ドキュメントのニーズを特定する
2. ドキュメントツールを選択する
3. ドキュメントの構成を計画する
4. スタイルガイドラインを定義する
5. ドキュメントサイトをセットアップする

コピー＆ペースト用プロンプト

Use @docs-architect to plan documentation structure

Use @documentation-templates to set up documentation

フェーズ 2：API ドキュメント

呼び出すスキル

• api-documenter - API ドキュメント
• api-documentation-generator - 自動生成
• openapi-spec-generation - OpenAPI 仕様

アクション

1. API エンドポイントを抽出する
2. OpenAPI 仕様を生成する
3. API リファレンスを作成する
4. 使用例を追加する
5. 自動生成をセットアップする

コピー＆ペースト用プロンプト

Use @api-documenter to generate API documentation

Use @openapi-spec-generation to create OpenAPI specs

フェーズ 3：アーキテクチャドキュメント

呼び出すスキル

• c4-architecture-c4-architecture - C4 アーキテクチャ
• c4-context - コンテキスト図
• c4-container - コンテナー図
• c4-component - コンポーネント図
• c4-code - コード図
• mermaid-expert - Mermaid 図

アクション

1. C4 図を作成する
2. アーキテクチャをドキュメント化する
3. シーケンス図を生成する
4. データフローをドキュメント化する
5. デプロイメントドキュメントを作成する

コピー＆ペースト用プロンプト

Use @c4-architecture-c4-architecture to create C4 diagrams

Use @mermaid-expert to create architecture diagrams

フェーズ 4：コードのドキュメント化

呼び出すスキル

• code-documentation-code-explain - コードの説明
• code-documentation-doc-generate - ドキュメント生成
• documentation-generation-doc-generate - 自動生成

アクション

1. コードコメントを抽出する
2. JSDoc/TSDoc を生成する
3. 型のドキュメントを作成する
4. 関数をドキュメント化する
5. 使用例を追加する

コピー＆ペースト用プロンプト

Use @code-documentation-code-explain to explain code

Use @code-documentation-doc-generate to generate docs

フェーズ 5：README と利用開始ガイド

呼び出すスキル

• readme - README の生成
• environment-setup-guide - セットアップガイド
• tutorial-engineer - チュートリアルの作成

アクション

1. README を作成する
2. 利用開始ガイドを作成する
3. インストール方法をドキュメント化する
4. 使用例を追加する
5. トラブルシューティングガイドを作成する

コピー＆ペースト用プロンプト

Use @readme to create project README

Use @tutorial-engineer to create tutorials

フェーズ 6：Wiki とナレッジベース

呼び出すスキル

• wiki-architect - Wiki アーキテクチャ
• wiki-page-writer - Wiki ページ
• wiki-onboarding - オンボーディングドキュメント
• wiki-qa - Wiki の Q&A
• wiki-researcher - Wiki の調査
• wiki-vitepress - VitePress Wiki

アクション

1. Wiki の構成を設計する
2. Wiki ページを作成する
3. オンボーディングガイドを作成する
4. プロセスをドキュメント化する
5. Wiki サイトをセットアップする

コピー＆ペースト用プロンプト

Use @wiki-architect to design wiki structure

Use @wiki-page-writer to create wiki pages

Use @wiki-onboarding to create onboarding docs

フェーズ 7：変更履歴とリリースノート

呼び出すスキル

• changelog-automation - 変更履歴の生成
• wiki-changelog - Git からの変更履歴作成

アクション

1. コミット履歴を抽出する
2. 変更を分類する
3. 変更履歴を生成する
4. リリースノートを作成する
5. 更新内容を準備する。公開は明示的に許可された宛先に限る

コピー＆ペースト用プロンプト

Use @changelog-automation to generate changelog

Use @wiki-changelog to create release notes

フェーズ 8：ドキュメントの保守

呼び出すスキル

• doc-coauthoring - 共同執筆
• reference-builder - リファレンスドキュメント

アクション

1. ドキュメントを確認する
2. 古くなった内容を更新する
3. リンク切れを修正する
4. 新機能を追加する
5. フィードバックを収集する

コピー＆ペースト用プロンプト

Use @doc-coauthoring to collaborate on docs

ドキュメントの種類

コードレベル

• JSDoc/TSDoc コメント
• 関数のドキュメント
• 型定義
• サンプルコード

API ドキュメント

• エンドポイントのリファレンス
• リクエスト／レスポンスのスキーマ
• 認証ガイド
• SDK ドキュメント

アーキテクチャドキュメント

• システム概要
• コンポーネント図
• データフロー図
• デプロイアーキテクチャ

ユーザードキュメント

• 入門ガイド
• ユーザーマニュアル
• チュートリアル
• FAQ

プロセスドキュメント

• ランブック
• オンボーディングガイド
• SOP
• 意思決定記録

品質ゲート

• すべての API がドキュメント化されている
• アーキテクチャ図が最新である
• README が最新である
• コードコメントが役立つ内容になっている
• サンプルが動作する
• リンクが有効である

関連するワークフローバンドル

• development - 開発ワークフロー
• testing-qa - ドキュメントのテスト
• ai-ml - AI ドキュメント

制限事項

• タスクが上記の説明の範囲に明確に当てはまる場合にのみ、このスキルを使用してください。
• 環境固有の検証、テスト、または専門家によるレビューの代わりとして、出力を扱わないでください。
• 必要な入力、権限、安全上の境界、または成功基準が不足している場合は、作業を中断して確認してください。