Skip to content

Commit 86c4e75

Browse files
committed
docs: align core guides with sidecar and Spec Kit base
1 parent 12c8c2b commit 86c4e75

11 files changed

Lines changed: 119 additions & 55 deletions

README.es.md

Lines changed: 17 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
<div align="center">
22
<h1>🌱 Spec-Driven Development Template</h1>
3-
<p><b>Inicia proyectos con disciplina basada en especificaciones y guía amigable para IA.</b></p>
3+
<p><b>Inicia proyectos con disciplina basada en especificaciones, GitHub Spec Kit como flujo base y guía amigable para IA.</b></p>
44

55
<p>
66
<a href="./README.md"><img src="https://img.shields.io/badge/🇺🇸_English-Read-blue?style=for-the-badge" alt="English"></a>
77
<a href="./README.es.md"><img src="https://img.shields.io/badge/🇪🇸_Español-Activo-green?style=for-the-badge" alt="Español"></a>
88
</p>
99

1010
<p>
11-
<img src="https://img.shields.io/badge/version-v1.3.0-blue?style=for-the-badge" alt="Version">
11+
<img src="https://img.shields.io/badge/version-v1.4.0-blue?style=for-the-badge" alt="Version">
1212
<a href="./START_HERE_NON_TECH.md"><img src="https://img.shields.io/badge/🧑‍💼_NO_TÉCNICO-Iniciar-green?style=for-the-badge" alt="Inicio no técnico"></a>
1313
<a href="./AI_START_HERE.md"><img src="https://img.shields.io/badge/🤖_INICIO_IA-Abrir-purple?style=for-the-badge" alt="AI Start"></a>
1414
<a href="./QUICKSTART.md"><img src="https://img.shields.io/badge/🚀_QUICKSTART-5_Minutos-ff6b35?style=for-the-badge" alt="Quickstart"></a>
@@ -21,14 +21,19 @@
2121

2222
## ⚡ Empieza en 30 segundos
2323

24+
Este framework usa [GitHub Spec Kit](https://github.com/github/spec-kit) como referencia principal del flujo de trabajo.
25+
Usa este repositorio como la capa práctica alrededor de esa base:
26+
- GitHub Spec Kit = motor de flujo de referencia
27+
- este repositorio = estructura inicial, instalación sidecar, reglas para IA, MCP y guía del proyecto
28+
2429
1. Abre [AI_START_HERE.md](./AI_START_HERE.md)
2530
o [START_HERE_NON_TECH.md](./START_HERE_NON_TECH.md) si no eres técnico.
2631
2. Copia y pega este prompt:
2732

2833
```text
2934
Usando https://github.com/juanklagos/spec-driven-development-template, guíame paso a paso con SDD para mi proyecto.
3035
Mi proyecto es: [explica tu proyecto en lenguaje simple].
31-
Si mi proyecto es nuevo, inicializa desde este template.
36+
Si mi proyecto es nuevo, inicializa desde este template y GitHub Spec Kit como flujo base.
3237
Si ya existe, adáptalo sin romper el comportamiento actual.
3338
No hay código sin spec aprobada y plan consistente.
3439
```
@@ -122,6 +127,7 @@ Archivos de referencia:
122127
## 🧭 Template vs proyecto real
123128

124129
- Este repositorio es un **marco/template**.
130+
- Usa **GitHub Spec Kit como referencia operativa base** para la secuencia de comandos y el flujo SDD.
125131
- La ruta profesional de producto es: raíz del framework + `packages/sdd-core` + `packages/sdd-mcp`.
126132
- El trabajo de producto debe ejecutarse en tu proyecto destino usando esta estructura.
127133
- Para proyectos reales, prefiere un sidecar compacto `spec/` dentro del proyecto y mantén el código en la raíz del proyecto.
@@ -157,6 +163,8 @@ flowchart TD
157163
A --> F["scripts/"]
158164
A --> G["packages/"]
159165
A --> H["www/"]
166+
H --> I["proyecto-destino/"]
167+
I --> J["spec/"]
160168
```
161169

162170
Carpetas obligatorias:
@@ -165,6 +173,11 @@ Carpetas obligatorias:
165173
- `bitacora/`: trazabilidad y handoffs
166174
- `docs/`: guías y referencias
167175

176+
En proyectos reales, esas carpetas SDD normalmente viven dentro de `./spec/`:
177+
- `./spec/idea/`
178+
- `./spec/specs/`
179+
- `./spec/bitacora/`
180+
168181
Paquete obligatorio por feature:
169182
1. `spec.md`
170183
2. `plan.md`
@@ -219,7 +232,7 @@ Paquete obligatorio por feature:
219232
- Roadmap: [Roadmap público](./docs/es/35-roadmap-publico.md)
220233
- Organización: [Mapa del proyecto](./docs/es/42-mapa-organizacion-proyecto.md)
221234
- Kit de medios: [Assets y posicionamiento](./docs/es/38-kit-medios.md)
222-
- Preparación próxima release: [v1.3.0](./docs/es/46-preparacion-v1.3.0.md)
235+
- Preparación histórica de release: [notas de v1.3.0](./docs/es/46-preparacion-v1.3.0.md)
223236
- Calidad: [Checklists por etapa](./docs/es/21-checklists-calidad-por-etapa.md) · [ADR](./docs/es/24-decisiones-de-arquitectura.md)
224237

225238
---

README.md

Lines changed: 17 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
<div align="center">
22
<h1>🌱 Spec-Driven Development Template</h1>
3-
<p><b>Start projects with specification-first discipline and AI-friendly guidance.</b></p>
3+
<p><b>Start projects with specification-first discipline, GitHub Spec Kit as the base workflow, and AI-friendly guidance.</b></p>
44

55
<p>
66
<a href="./README.md"><img src="https://img.shields.io/badge/🇺🇸_English-Active-blue?style=for-the-badge" alt="English"></a>
77
<a href="./README.es.md"><img src="https://img.shields.io/badge/🇪🇸_Español-Read-green?style=for-the-badge" alt="Español"></a>
88
</p>
99

1010
<p>
11-
<img src="https://img.shields.io/badge/version-v1.3.0-blue?style=for-the-badge" alt="Version">
11+
<img src="https://img.shields.io/badge/version-v1.4.0-blue?style=for-the-badge" alt="Version">
1212
<a href="./START_HERE_NON_TECH.md"><img src="https://img.shields.io/badge/🧑‍💼_NON--TECH-Start-green?style=for-the-badge" alt="Non Technical Start"></a>
1313
<a href="./AI_START_HERE.md"><img src="https://img.shields.io/badge/🤖_AI_START-Open-purple?style=for-the-badge" alt="AI Start"></a>
1414
<a href="./QUICKSTART.md"><img src="https://img.shields.io/badge/🚀_QUICKSTART-5_Minutes-ff6b35?style=for-the-badge" alt="Quickstart"></a>
@@ -21,14 +21,19 @@
2121

2222
## ⚡ Start in 30 Seconds
2323

24+
This framework uses [GitHub Spec Kit](https://github.com/github/spec-kit) as the primary workflow reference.
25+
Use this repository as the practical layer around that base:
26+
- GitHub Spec Kit = reference workflow engine
27+
- this repository = starter structure, sidecar installation, AI rules, MCP, and project guidance
28+
2429
1. Open [AI_START_HERE.md](./AI_START_HERE.md)
2530
or [START_HERE_NON_TECH.md](./START_HERE_NON_TECH.md) if you are non-technical.
2631
2. Copy/paste this prompt:
2732

2833
```text
2934
Using https://github.com/juanklagos/spec-driven-development-template, guide me step by step with SDD for my project.
3035
My project is: [describe your project in plain language].
31-
If my project is new, initialize from this template.
36+
If my project is new, initialize from this template and GitHub Spec Kit as the base workflow.
3237
If it already exists, adapt it without breaking current behavior.
3338
No code before approved spec and consistent plan.
3439
```
@@ -122,6 +127,7 @@ Reference files:
122127
## 🧭 Template vs Real Project
123128

124129
- This repository is a **framework/template**.
130+
- It uses **GitHub Spec Kit as the base operating reference** for the command sequence and SDD flow.
125131
- The professional productization path is: framework root + `packages/sdd-core` + `packages/sdd-mcp`.
126132
- Your product work should run in your target project using this structure.
127133
- For real projects, prefer a compact `spec/` sidecar inside the project and keep code in the project root.
@@ -157,6 +163,8 @@ flowchart TD
157163
A --> F["scripts/"]
158164
A --> G["packages/"]
159165
A --> H["www/"]
166+
H --> I["target-project/"]
167+
I --> J["spec/"]
160168
```
161169

162170
Mandatory folders:
@@ -165,6 +173,11 @@ Mandatory folders:
165173
- `bitacora/`: execution trace and handoffs
166174
- `docs/`: usage guides and references
167175

176+
For real target projects, those SDD folders usually live under `./spec/`:
177+
- `./spec/idea/`
178+
- `./spec/specs/`
179+
- `./spec/bitacora/`
180+
168181
Mandatory spec bundle (for each feature):
169182
1. `spec.md`
170183
2. `plan.md`
@@ -219,7 +232,7 @@ Mandatory spec bundle (for each feature):
219232
- Roadmap: [Public Roadmap](./docs/en/35-public-roadmap.md)
220233
- Organization: [Project Map](./docs/en/42-project-organization-map.md)
221234
- Media Kit: [Assets and Positioning](./docs/en/38-media-kit.md)
222-
- Next Release Prep: [v1.3.0](./docs/en/46-v1.3.0-preparation.md)
235+
- Historical Release Prep: [v1.3.0 prep notes](./docs/en/46-v1.3.0-preparation.md)
223236
- Quality: [Stage Checklists](./docs/en/21-quality-checklists-by-stage.md) · [ADR](./docs/en/24-architecture-decisions.md)
224237

225238
---

docs/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Start here / Empieza aquí:
1010
```text
1111
Using https://github.com/juanklagos/spec-driven-development-template, create everything needed to carry out my project end-to-end.
1212
My project is: [describe your project in plain language].
13-
If my project is new, initialize it with this template + GitHub Spec Kit.
13+
If my project is new, initialize it with this template, using GitHub Spec Kit as the base workflow.
1414
If it already exists, adapt it to idea/specs/bitacora without breaking behavior.
1515
Guide me by level (beginner/intermediate/advanced) using simple language.
1616
```

docs/en/01-structure.md

Lines changed: 20 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -26,19 +26,31 @@ Recommended target-project shape:
2626
- project root = app code
2727
- `spec/` = SDD operating system
2828

29+
That means:
30+
- `spec/idea/`
31+
- `spec/specs/`
32+
- `spec/bitacora/`
33+
34+
GitHub Spec Kit remains the base workflow reference for the project.
35+
This repository adds the structure, sidecar mode, AI rules, and guidance around that base.
36+
2937

3038

3139
## idea
3240

33-
Path: `idea/`
41+
Path:
42+
- framework root mode: `idea/`
43+
- real project sidecar mode: `spec/idea/`
3444

3545
Main file:
3646

3747
- `IDEA_GENERAL.md`: defines project problem, goal, scope, users, risks, and completion criteria.
3848

3949
## specs
4050

41-
Path: `specs/`
51+
Path:
52+
- framework root mode: `specs/`
53+
- real project sidecar mode: `spec/specs/`
4254

4355
Main files:
4456

@@ -54,7 +66,9 @@ Each specification lives in a numbered folder:
5466

5567
## bitacora
5668

57-
Path: `bitacora/`
69+
Path:
70+
- framework root mode: `bitacora/`
71+
- real project sidecar mode: `spec/bitacora/`
5872

5973
Subfolders:
6074

@@ -72,7 +86,9 @@ Contains educational documentation for this system.
7286

7387
## scripts
7488

75-
Path: `scripts/`
89+
Path:
90+
- framework root mode: `scripts/`
91+
- real project sidecar mode: `spec/scripts/`
7692

7793
Contains scripts to initialize this structure in other repositories.
7894

docs/en/34-launch-kit.md

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -17,13 +17,13 @@ flowchart LR
1717
## Short update
1818

1919
```text
20-
Spec-Driven Development Template now includes a real MCP server.
20+
Spec-Driven Development Template now defaults to a clean `spec/` sidecar architecture for real projects.
2121
22-
New in v1.3.0:
23-
- local `sdd-mcp` server
24-
- stdio + Streamable HTTP
25-
- copy-paste configs for Cursor, Claude Code, and Codex
26-
- active project resources for idea, specs, logbook, and handoffs
22+
New in v1.4.0:
23+
- compact `spec/` sidecar prompts for AI tools
24+
- cleaner project layout for advanced or existing codebases
25+
- MCP contracts aligned with sidecar projects
26+
- link-check and MCP CI fixes for the new architecture
2727
2828
Repository:
2929
https://github.com/juanklagos/spec-driven-development-template
@@ -32,19 +32,20 @@ https://github.com/juanklagos/spec-driven-development-template
3232
## LinkedIn post
3333

3434
```text
35-
I just shipped v1.3.0 of my Spec-Driven Development Template.
35+
I just shipped v1.4.0 of my Spec-Driven Development Template.
3636
3737
This repository is evolving into an operational SDD framework, not just a documentation starter.
3838
3939
What it now includes:
4040
- GitHub Spec Kit as the primary reference flow
41+
- `spec/` sidecar as the professional default for real projects
4142
- multi-agent operating rules
42-
- runnable work defaults cleanly to ./www/<project-name> while still supporting external target paths
43+
- clean internal container support under ./www/<project-name> when the project lives inside the template
4344
- local MCP server (`sdd-mcp`)
4445
- stdio + Streamable HTTP
4546
- typed SDD core
4647
- MCP integration tests and CI
47-
- copy-paste client configs for Cursor, Claude Code, and Codex
48+
- copy-paste sidecar prompts so AI tools stop copying the whole repository into advanced projects
4849
4950
Repository:
5051
https://github.com/juanklagos/spec-driven-development-template
@@ -55,5 +56,5 @@ The goal is to reduce friction from idea -> spec -> plan -> tasks -> validation,
5556
## Short release note
5657

5758
```text
58-
v1.3.0 strengthens the framework as an easier operational SDD system: easy MCP guides, hosted onboarding model, client visual examples, package version alignment, and a clearer path for non-technical adoption.
59+
v1.4.0 makes the framework cleaner to apply in real projects: `spec/` sidecar by default, GitHub Spec Kit as the base workflow reference, MCP behavior aligned with sidecar projects, and exact prompts that stop AI tools from copying the whole repository into advanced codebases.
5960
```

docs/en/35-public-roadmap.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,25 +8,27 @@ This roadmap makes the next product steps explicit so users know where the frame
88

99
```mermaid
1010
flowchart LR
11-
A["v1.3.0"] --> B["v1.4.0"]
12-
B --> C["v1.5.0"]
11+
A["v1.4.0"] --> B["v1.5.0"]
12+
B --> C["v1.6.0"]
1313
```
1414

1515
## Current state
1616

1717
Released:
18-
- `v1.3.0`
18+
- `v1.4.0`
1919

2020
Now available:
2121
- SDD framework with multi-agent policy
22-
- recommended default workspace in `./www/<project-name>/`, with support for external target paths
22+
- GitHub Spec Kit as the base workflow reference
23+
- recommended `spec/` sidecar for real target projects
24+
- `./www/<project-name>/` as the clean internal container when the project lives inside this repository
2325
- typed `sdd-core`
2426
- local `sdd-mcp`
2527
- `stdio` + `Streamable HTTP`
2628
- MCP tools, resources, prompts, smoke tests, and integration tests
2729
- client setup recipes and package version alignment
2830

29-
## v1.4.0
31+
## v1.5.0
3032

3133
Focus: hosted onboarding hardening and richer operator experience.
3234

@@ -37,7 +39,7 @@ Planned:
3739
- tested setup guides with screenshots for Cursor, Claude Code, and Codex
3840
- stronger release automation and packaging guidance
3941

40-
## v1.5.0
42+
## v1.6.0
4143

4244
Focus: framework standardization and publishable MCP packaging.
4345

docs/en/37-versioning-strategy.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,9 @@ flowchart LR
1818
- `@sdd/sdd-core` and `@sdd/sdd-mcp` should stay aligned with the repository minor release
1919

2020
Current alignment:
21-
- framework: `1.3.0`
22-
- `@sdd/sdd-core`: `1.3.0`
23-
- `@sdd/sdd-mcp`: `1.3.0`
21+
- framework: `1.4.0`
22+
- `@sdd/sdd-core`: `1.4.0`
23+
- `@sdd/sdd-mcp`: `1.4.0`
2424

2525
## Practical release policy
2626

docs/es/01-estructura.md

Lines changed: 20 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -26,19 +26,31 @@ Forma recomendada del proyecto destino:
2626
- raíz del proyecto = código app
2727
- `spec/` = sistema operativo SDD
2828

29+
Eso significa:
30+
- `spec/idea/`
31+
- `spec/specs/`
32+
- `spec/bitacora/`
33+
34+
GitHub Spec Kit sigue siendo la referencia base del flujo de trabajo.
35+
Este repositorio agrega la estructura, el modo sidecar, las reglas para IA y la guía alrededor de esa base.
36+
2937

3038

3139
## Carpeta idea
3240

33-
Ruta: `idea/`
41+
Ruta:
42+
- modo raíz del framework: `idea/`
43+
- modo sidecar en proyecto real: `spec/idea/`
3444

3545
Archivo principal:
3646

3747
- `IDEA_GENERAL.md`: define el problema, objetivo, alcance, usuarios, riesgos y criterio de terminado.
3848

3949
## Carpeta specs
4050

41-
Ruta: `specs/`
51+
Ruta:
52+
- modo raíz del framework: `specs/`
53+
- modo sidecar en proyecto real: `spec/specs/`
4254

4355
Archivos principales:
4456

@@ -54,7 +66,9 @@ Cada especificación vive en una carpeta enumerada:
5466

5567
## Carpeta bitacora
5668

57-
Ruta: `bitacora/`
69+
Ruta:
70+
- modo raíz del framework: `bitacora/`
71+
- modo sidecar en proyecto real: `spec/bitacora/`
5872

5973
Subcarpetas:
6074

@@ -72,7 +86,9 @@ Contiene la documentación pedagógica del sistema.
7286

7387
## Carpeta scripts
7488

75-
Ruta: `scripts/`
89+
Ruta:
90+
- modo raíz del framework: `scripts/`
91+
- modo sidecar en proyecto real: `spec/scripts/`
7692

7793
Contiene scripts para instalar esta estructura en otro repositorio.
7894

0 commit comments

Comments
 (0)