| name | design-doc |
| description | Design Doc(設計ドキュメント)作成スキル。プロジェクトの設計書を構造化して作成する。「設計書を作りたい」「Design Docを書きたい」「アーキテクチャを文書化したい」などのリクエスト時に使用。要件定義、システム設計、API設計、データモデル、テスト戦略、リスク管理を網羅。 |
Design Doc 作成
プロジェクトの設計ドキュメントを構造化して作成するスキル。
ワークフロー
1. プロジェクト概要のヒアリング
↓
2. 要件・制約の確認
↓
3. テンプレートに沿ってDesign Doc生成
↓
4. ユーザー確認・修正
Step 1: ヒアリング
ユーザーの要求を受けたら、以下の観点で質問する。
必須項目
概要
- プロジェクト名
- 目的(2-3文で)
- 作成者・関係者
背景と課題
- 現状の問題点
- 解決したい課題
スコープ
- 対象範囲
- 対象外(明確に除外するもの)
技術的項目
要件
- 機能要件(優先度付き)
- 非機能要件(パフォーマンス、可用性、セキュリティ)
- 制約条件(技術、予算、スケジュール)
設計
- 使用技術スタック
- アーキテクチャ概要
- データモデル
- API設計(エンドポイント、メソッド)
Step 2: Design Doc 生成
ヒアリング結果を元に .specs/{project-name}/design-doc.md を生成。
テンプレート: assets/templates/design-doc-template.md
必須セクション
- 概要(プロジェクト名、関係者、サマリー)
- 背景と目的(課題、目的、スコープ)
- 要件定義(機能要件、非機能要件、制約)
- システム設計(アーキテクチャ、技術スタック、データモデル、API)
- 実装計画(フェーズ分け、タスク分解)
- テスト戦略(テスト計画、品質基準)
- リスク管理(リスク、影響度、対策)
- 運用・保守(デプロイ、モニタリング、保守計画)
- 成功指標(KPI)
Step 3: ユーザー確認
生成したDesign Docをユーザーに提示:
- 各セクションの概要サマリー
- 「修正が必要な場合はお知らせください」
出力
.specs/
└── {project-name}/
└── design-doc.md
{project-name} はケバブケースで命名。