搜索

PythonReactSEOPDF
GitHub Skill

spec-authoring

Author ADR, PRD, and SDS specifications following SEA™ templates with full traceability. Use when creating architecture decision records (ADRs), product requirement documents (PRDs), or software design specifications (SDS) that require proper spec-to-code traceability and document relationships.

GodSpeedAI☆ 1 仓库 Stars0 仓库 Forks

安装与使用

请根据来源仓库和你的 AI 工具说明安装此技能。先阅读技能文件和依赖要求,再添加到工作流。

查看来源 ↗使用指南

技能说明

Specification Authoring Skill

Creates properly structured ADR, PRD, and SDS documents with full traceability.

Document Types

ADR (Architecture Decision Record)

Purpose: Capture architecture decisions with context, options, and consequences.

Template Fields:

  • ADR-ID (e.g., ADR-031)
  • Status (Proposed, Accepted, Deprecated)
  • Context & Problem Statement
  • Decision Drivers
  • Considered Options
  • Decision Outcome
  • Consequences (positive, negative, neutral)
  • Links to follow-up PRDs/SDS
PRD (Product Requirement Document)

Purpose: Define product requirements and acceptance criteria.

Template Fields:

  • PRD-ID (e.g., PRD-020)
  • Problem Statement
  • User Stories (EARS format)
  • Functional Requirements (FR-###)
  • Non-Functional Requirements (NFR-###)
  • Acceptance Criteria
  • Traceability to ADRs
SDS (Software Design Specification)

Purpose: Detailed technical design with SEA-DSL flows.

Format: YAML frontmatter + Markdown content

Template Fields:

  • SDS-ID (e.g., SDS-045)
  • Bounded Context
  • Service/Component name
  • Implements (ADR/PRD references)
  • SEA-DSL specification
  • API contracts
  • Invariants

Traceability Chain

ADR → PRD → SDS → SEA-DSL → Generated Code

Each document MUST reference its upstream documents:

  • SDS must reference PRD and/or ADR it implements
  • PRD must reference ADR it satisfies

Workflow

  1. Identify what decision/requirement/design to document
  2. Choose appropriate document type (ADR/PRD/SDS)
  3. Use /spec workflow to create from template
  4. Fill in all required fields
  5. Add traceability links
  6. Validate with just spec-guard

File Locations

Type Path Pattern
ADR docs/specs/<context>/adr/<###>-<name>.md
PRD docs/specs/<context>/prd/<###>-<name>.md
SDS docs/specs/<context>/sds/<###>-<name>.sds.yaml or .md

Related Skills

使用示例

查看来源仓库中的使用示例与配置说明。

查看来源 ↗

来源历史

收录时间
2026-01-20
索引更新时间
2026-01-26
Branch
main

收录与同步日期属于本站记录。源码修改历史请查看来源仓库。

GitHub ↗

chat Comments (0)

chat_bubble_outline

No comments yet. Be the first to share your thoughts!