spec-driven-development-template

mcp
Security Audit
Pass
Health Pass
  • License — License: NOASSERTION
  • Description — Repository has a description
  • Active repo — Last push 0 days ago
  • Community trust — 10 GitHub stars
Code Pass
  • Code scan — Scanned 12 files during light audit, no dangerous patterns found
Permissions Pass
  • Permissions — No dangerous permissions requested

No AI report is available for this listing yet.

SUMMARY

Operational SDD framework with AI guidance, GitHub Spec Kit workflows, and MCP support.

README.md

🌱 Spec-Driven Development Template

Learn Spec-Driven Development (SDD) and apply it to real projects — with AI as your co-pilot and GitHub Spec Kit as the base workflow.

English Español

Version Non Technical Start AI Start Quickstart Open in GitHub Codespaces

Social Preview


🌟 What is this?

Spec-Driven Development (SDD) means writing and approving a clear specification before any code is written — so decisions, scope, and quality survive beyond a chat window. In 2026 it is the dominant practice for building software with AI agents.

This repository is two things at once:

  1. A school — a bilingual (EN/ES), level-based path to learn SDD from zero, even if you don't program.
  2. A toolkit — a ready-to-use structure to apply SDD in real projects: enforcement scripts, AI agent rules, a local MCP server, and a compact spec/ sidecar for existing codebases.

It uses GitHub Spec Kit as the reference workflow engine; this repo is the practical layer around it (starter structure, guidance, rules, and validation).

❌ Without SDD ✅ With this template
Decisions lost in chat history Single source of truth in specs/
Code created without planning Mandatory spec.md + plan.md gate, machine-checked
Hard onboarding for teams/AI Standard structure and level-based guides
Weak traceability Session logs in bitacora/, history per spec

🔭 Want the industry map? Read SDD in 2026: state of the art and how this template compares.

🚪 Choose your door

Three entry points, one for each kind of visitor:

You are... Start here What you get
🧑‍💼 Non-technical (founder, PM, curious) START_HERE_NON_TECH.md Ultra-simple guided start, no jargon
👩‍💻 Developer QUICKSTART.md Commands to scaffold and validate in 5 minutes
🤖 AI agent (or you, pasting into one) AI_START_HERE.md Operating rules + copy/paste prompts by level

Then pick your learning level:

⚡ Start in 30 seconds

Copy/paste this prompt into your AI assistant (Claude, Cursor, Copilot, Gemini...):

Using https://github.com/juanklagos/spec-driven-development-template, guide me step by step with SDD for my project.
My project is: [describe your project in plain language].
If my project is new, initialize from this template and GitHub Spec Kit as the base workflow.
If it already exists, adapt it without breaking current behavior.
No code before approved spec and consistent plan.

🎛️ Built-in commands for your AI agent

If you use Claude Code, this repo ships slash commands out of the box — start with /sdd:help:

Command What it does
/sdd:help Diagnoses your current stage and gives the single next step
/sdd:new Guided start: idea → first spec ready for approval
/sdd:spec Create or refine a spec bundle with EARS criteria
/sdd:gate Runs the machine-checked gate and records your consent
/sdd:close Validates and closes the session with the output contract
/sdd:tutor Conversational SDD course by levels, graded by the real validation scripts

Install in any project as a plugin (no cloning):

/plugin marketplace add juanklagos/spec-driven-development-template
/plugin install sdd@sdd-template

🚨 The golden rule

No code before an approved spec.md and a consistent plan.md.

This is not just prose — it is machine-checked:

./scripts/check-sdd-policy.sh .   # multi-agent policy files are aligned
./scripts/check-sdd-gate.sh .     # spec approved + plan consistent + consent recorded

Before implementation starts, explicit user consent is recorded:

./scripts/confirm-user-consent.sh "User approved scope X"

(In sidecar projects the same scripts live under ./spec/scripts/.)

Enforce it in CI too — this repo doubles as a GitHub Action:

- uses: juanklagos/spec-driven-development-template@main
  with:
    path: "."      # project root (sidecar or standalone auto-detected)
    strict: "true"

Reference files: sdd.policy.yaml · INSTRUCTIONS.md · AGENT_OPERATING_SYSTEM.md

🎬 How it works

flowchart LR
  A["Idea in plain language"] --> B["spec.md approved"]
  B --> C["plan.md consistent"]
  C --> D["tasks.md prioritized"]
  D --> E["Gate + explicit consent"]
  E --> F["Implementation"]
  F --> G["Validation + logbook"]

Every feature gets a numbered spec bundle:

  1. spec.md — what and why (approved by you)
  2. plan.md — how (consistent with the spec)
  3. tasks.md — concrete steps
  4. history.md — how it evolved

And every session leaves a trace in bitacora/ (logbook): decisions, handoffs, next step.

See the real flow (create spec → validate → gate), regenerated automatically on every release:

SDD flow demo: create a spec, validate the structure, pass the gate

Full walkthrough example: examples/002-mcp-end-to-end

🧭 Apply it to a real project

Three ways to use the template, from lightest to heaviest:

Mode When Command
Compact spec/ sidecar (recommended) Real or existing project: SDD artifacts in ./spec/, code stays in your project root ./scripts/install-spec-sidecar.sh /path/to/project --profile=recommended
Internal workspace www/ The runnable project should live inside this template repo ./scripts/create-www-project.sh my-project codex
Full standalone copy You explicitly want the whole framework as your workspace ./scripts/init-project.sh /path/to/project --profile=full

[!TIP]
Default professional path: install only the compact spec/ sidecar. Never copy the full framework into a real codebase unless you explicitly want standalone mode.

Everyday commands (sidecar mode shown; same scripts exist at root in standalone mode):

Action Command
New spec ./spec/scripts/new-spec.sh "my-feature" "Owner"
Validate structure ./spec/scripts/validate-sdd.sh . --strict
Policy check ./spec/scripts/check-sdd-policy.sh .
SDD gate ./spec/scripts/check-sdd-gate.sh .
Status dashboard ./spec/scripts/generate-status.sh

Folder anatomy, project map and layout details: docs/en/42-project-organization-map.md

flowchart TD
  A["Your project root (code)"] --> B["spec/"]
  B --> C["idea/"]
  B --> D["specs/ (numbered bundles)"]
  B --> E["bitacora/ (logbook)"]
  B --> F["scripts/ (gate + validation)"]

🔌 Connect via MCP (optional, advanced)

If your AI client supports MCP, this repo ships a local sdd-mcp server so the SDD workflow becomes guided commands (/start-project, /create-spec ...).

npm install
npm run build
npm run mcp:start

Note: GitMCP (free, remote) helps an AI read this public repo; the local sdd-mcp runs the real guided workflow. They complement each other: GitMCP guide.

📚 Documentation

Three essential reads:

  1. Workflow — the SDD flow step by step
  2. Structure — what each folder is for
  3. SDD in 2026: state of the art — the industry map and where this template stands

Everything else: the full documentation index organizes all 51 guides (EN/ES) by topic: learning path, prompts, MCP, quality, team mode, legacy migration, legal.

⚖️ Legal & authorship

Reviews (0)

No results found