sdd-documentation

windschord's avatarfrom windschord

ソフトウェア設計ドキュメント（SDD）を作成・管理・実装します。requirements.md、design.md、tasks.mdの作成から、タスク実行・逆順レビューまでの全工程を統括します。SDDワークフロー全体の管理が必要な場合に使用してください。

⭐0stars🔀0forks📁View on GitHub🕐Updated Jan 1, 2026
[Architecture Design]

When & Why to Use This Skill

The SDD Documentation skill is a powerful orchestrator designed to manage the end-to-end Software Design Document (SDD) lifecycle. It streamlines the transition from initial requirements to final implementation by coordinating specialized sub-skills for EARS-based requirement definition, technical architecture design, AI-optimized task planning, and code execution. By maintaining a structured documentation hierarchy and enforcing a rigorous 'reverse review' process, it ensures that software development remains traceable, consistent, and high-quality from conception to deployment.

Use Cases

  • Full-Cycle Project Initialization: Automatically generate a standardized documentation framework (requirements, design, and tasks) for new software projects to ensure a solid architectural foundation.
  • Requirement Engineering with EARS: Transform vague user needs into structured, unambiguous requirements using the Easy Approach to Requirements Syntax (EARS) for better developer alignment.
  • Technical Architecture & Schema Design: Create comprehensive technical blueprints, including component interactions, API specifications, and database schemas, while documenting key architectural decisions.
  • AI-Agent Task Decomposition: Break down complex software designs into granular, actionable tasks specifically optimized for execution by AI coding agents.
  • Traceability and Reverse Review: Perform systematic 'reverse reviews' (Implementation -> Task -> Design -> Requirements) to verify that the final code perfectly aligns with the original project goals and constraints.
namesdd-documentation
descriptionソフトウェア設計ドキュメント（SDD）を作成・管理・実装します。requirements/、design/、tasks/の作成から、タスク実行・逆順レビューまでの全工程を統括します。SDDワークフロー全体の管理が必要な場合に使用してください。
version"1.0.0"

SDD ドキュメンテーションスキル

ソフトウェア設計ドキュメント（SDD）の作成・管理・実装を統括するオーケストレータースキルです。

概要

このスキルは、以下の4つのサブスキルを連携させて、要件定義から実装までの全工程を管理します：

サブスキル 役割 成果物
requirements-defining EARS記法による要件定義 docs/requirements/
software-designing 技術アーキテクチャ設計 docs/design/
task-planning AIエージェント向けタスク分解 docs/tasks/
task-executing タスク実行・逆順レビュー 実装コード

ドキュメント構成

docs/
├── requirements/           # 要件定義
│   ├── index.md           # 目次・概要
│   ├── stories/US-XXX.md  # ユーザーストーリー詳細
│   └── nfr/*.md           # 非機能要件
├── design/                # 設計
│   ├── index.md           # 目次・アーキテクチャ概要
│   ├── components/*.md    # コンポーネント詳細
│   ├── api/*.md           # API設計詳細
│   ├── database/schema.md # データベーススキーマ
│   └── decisions/DEC-XXX.md # 技術的決定事項
└── tasks/                 # タスク管理
    ├── index.md           # 目次・進捗サマリ
    └── phase-N/TASK-XXX.md # タスク詳細

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

一括初期化

  • 新規プロジェクトでSDDドキュメント一式が必要な場合

全体管理

  • 3つのドキュメント間の整合性を確認したい場合
  • 逆順レビュー（タスク → 設計 → 要件）を実施したい場合

実装フェーズ

  • docs/tasks/に沿って実装を行う場合
  • 実装後の逆順レビューが必要な場合

個別作業が必要な場合

特定の工程のみ実施する場合は、各サブスキルを直接使用：

  • 要件定義のみ → requirements-defining
  • 設計のみ → software-designing
  • タスク計画のみ → task-planning
  • 実装のみ → task-executing

ワークフロー

1. 初期化 → docs/ディレクトリ構造を作成
      ↓
2. requirements-defining → docs/requirements/
      ↓ ユーザー確認・承認
3. software-designing → docs/design/
      ↓ ユーザー確認・承認
4. task-planning → docs/tasks/
      ↓ ユーザー確認・承認
5. ドキュメント逆順レビュー
      ↓
6. task-executing → 実装コード
      ↓
7. 実装逆順レビュー → 完了

ドキュメント初期化

「docsディレクトリを初期化してください」と依頼されたら：

  1. ディレクトリ構造の作成
  2. requirements/index.md - テンプレート: requirements-defining/assets/templates/requirements_index_template_ja.md
  3. design/index.md - テンプレート: software-designing/assets/templates/design_index_template_ja.md
  4. tasks/index.md - テンプレート: task-planning/assets/templates/tasks_index_template_ja.md

逆順レビュープロセス

docs/tasks/ → docs/design/ → docs/requirements/

詳細なチェック項目は references/checklist_ja.md を参照。

EARS記法クイックリファレンス

パターン 形式 使用場面
基本 システムは〜しなければならない 常時適用される要件
イベント 〜の時、システムは〜しなければならない イベント駆動要件
条件 もし〜ならば、システムは〜しなければならない 状態依存要件
継続 〜の間、システムは〜しなければならない 継続的要件
場所 〜において、システムは〜しなければならない コンテキスト固有要件

ユーザーとの対話ガイドライン

情報分類プロセス

  1. 明示された情報: ユーザーが明確に述べた要件、仕様、制約
  2. 不明な情報: 推測が必要な項目（「おそらく〜」は不明として扱う）

確認の形式

ドキュメント作成の前に、以下の点を確認させてください：

【明示された情報】
- [ユーザーから明示的に指定された内容]

【不明/要確認の情報】
1. [項目1]: [選択肢A] / [選択肢B] / その他
2. [項目2]: [具体的な質問]

上記の不明点について教えていただけますか？

リソース

リファレンス

  • ワークフローガイド: references/workflow_guide_ja.md
  • 検証チェックリスト: references/checklist_ja.md

サブスキル

  • 要件定義: requirements-defining/SKILL.md
  • 設計: software-designing/SKILL.md
  • タスク計画: task-planning/SKILL.md
  • タスク実行: task-executing/SKILL.md