Skip to content

juanklagos/spec-driven-development-template

Use this GitHub action with your project
Add this Action to an existing workflow or create a new one
View on Marketplace

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

112 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

Spec-Driven Development Template

🌱 Spec-Driven Development Template

Learn Spec-Driven Development and apply it to real projects β€”
with AI as your co-pilot and one golden rule, checked by machine.

πŸ‡ΊπŸ‡Έ English Β· πŸ‡ͺπŸ‡Έ EspaΓ±ol

Version License Latest release

Documentation site Interactive course SDD Validate on GitHub Marketplace Open in GitHub Codespaces

Non-technical start Β· Quickstart Β· AI agent start Β· Commands Β· Community


🌟 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:

πŸŽ“ A school 🧰 A toolkit
What Bilingual (EN/ES), level-based path to learn SDD from zero Ready-to-use structure to apply SDD in real projects
How Guides, interactive course, conversational tutor Enforcement scripts, agent rules, MCP server, compact spec/ sidecar
For whom Even if you don't program Solo devs, teams, and AI agents

It uses GitHub Spec Kit as the reference workflow engine; this repo is the practical layer around it.

The flow in action β€” create a spec, validate, pass the gate (regenerated on every release):

SDD flow demo: create a spec, validate the structure, pass the gate
❌ 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

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 β€” every guide on the docs site carries its level badge:

Tip

Prefer learning by doing? Take the interactive course (GitHub Skills format): 4 steps, ~35 min, auto-graded by Actions β€” finish with the real SDD gate as your exam.

⚑ 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

Important

No code before an approved spec.md and a consistent plan.md. Not just prose β€” it is machine-checked, and implementation only starts after your recorded consent.

./scripts/check-sdd-policy.sh .   # multi-agent policy files are aligned
./scripts/check-sdd-gate.sh .     # spec approved + plan consistent + consent 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, listed on the GitHub Marketplace:

- uses: juanklagos/spec-driven-development-template@v1.5.0
  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"]
Loading

Every feature gets a numbered spec bundle, and every session leaves a trace in bitacora/ (logbook):

  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

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 ⭐ 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 and layout details: project organization map

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)"]
Loading
πŸ”Œ 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

Browse online: the documentation site has every guide with search, EN/ES language picker, and level badges.

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.

πŸ’¬ Community

βš–οΈ Legal & authorship


If this template helps you build with discipline, ⭐ star the repo β€” it helps others find it.

🌱 No code before approved spec and consistent plan.

⬆️ Back to top