sdd

Solid

Create a Software Design Document (SDD) defining component architecture, data contracts, API schemas, and platform compatibility before planning. Use in Tier 3 (Full Pipeline) or when modifying interfaces, hooks, databases, or multi-platform contracts.

Data & Documents 22 stars 5 forks Updated 6 days ago MIT

Install

View on GitHub

Quality Score: 84/100

Stars 20%
45
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
80
License 10%
100
Description 5%
100

Skill Content

# /supergraph:sdd Draft a machine-readable Software Design Document (SDD) with Mermaid architecture diagrams, strict data/interface contracts, and platform compatibility matrices before task decomposition in `/supergraph:plan`. Announce: "📐 /supergraph:sdd — drafting Software Design Document..." ## Quick Gate - **Micro Tier** (<20 lines, ≤2 files, no schema/API/hook changes) → skip directly to `/supergraph:tdd`. - **Standard Tier** (≤5 files, clear local change, no cross-boundary) → optional; draft mini-spec if touching API/data contracts. - **Full Tier** (>5 files, architectural change, API/schema modification, multi-platform runtime) → **MANDATORY**. --- ## Steps ### 1. Load Context & Architecture **1a. Read Domain Vocabulary:** ```bash head -60 CONTEXT.md 2>/dev/null || echo "No CONTEXT.md" ``` Always reuse terms from `CONTEXT.md` for entities, roles, and components. **1b. Read PRD (if exists):** Check latest PRD in `docs/supergraph/plans/*prd*.md`: ```bash ls -t docs/supergraph/plans/*prd*.md 2>/dev/null | head -1 ``` **1c. Codebase Architecture Overview:** Query `codebase-memory-mcp` (`get_architecture` with `overview`, `layers`, `boundaries`) or inspect hub nodes with Serena. Identify affected components and cross-module boundaries. --- ### 2. Draft Software Design Document (SDD) Generate the document using the following structured template: ```markdown # SDD: [Feature / System Name] Date: YYYY-MM-DD Status: draft | approved ## 1. Context & Scope - **Prob...

Details

Author
datit309
Repository
datit309/supergraph
Created
4 months ago
Last Updated
6 days ago
Language
Shell
License
MIT

Similar Skills

Semantically similar based on skill content — not just same category