Skip to content

QUICKSTART.md

Latest commit

 

History

History
136 lines (99 loc) · 3.79 KB

QUICKSTART.md

File metadata and controls

136 lines (99 loc) · 3.79 KB
Raw

Quickstart / Inicio rápido

Goal / Objetivo:

  • EN: start SDD fast with the least friction.
  • ES: iniciar SDD rápido con la menor fricción.

Route A: Non-technical (recommended) / Ruta A: No técnica (recomendada)

  1. Open START_HERE_NON_TECH.md
  2. Copy the base prompt and share your project idea
  3. Ask the AI to guide you step by step

Route B: Technical / Ruta B: Técnica

1) Get the template / Obtén el template

npx degit juanklagos/spec-driven-development-template my-project
cd my-project

Alternative / Alternativa:

git clone https://github.com/juanklagos/spec-driven-development-template.git my-project
cd my-project

2) Create execution workspace / Crea espacio de ejecución

./scripts/create-www-project.sh my-project codex
cd www/my-project

Important / Importante:

  • EN: ./www/... is the recommended default workspace inside this template.
  • ES: ./www/... es el espacio recomendado por defecto dentro de este template.
  • EN: You can also initialize an external target path when the runnable project should live elsewhere.
  • ES: También puedes inicializar una ruta externa si el proyecto ejecutable debe vivir en otro lugar.

Default:

  • EN: recommended scaffold (best default for project quality).
  • ES: scaffold recomendado (mejor valor por defecto para calidad del proyecto).

Minimal only:

./scripts/create-www-project.sh my-project codex --minimal-template
cd www/my-project

Optional full packs:

./scripts/create-www-project.sh my-project codex --full-template
cd www/my-project

External target path (compact sidecar, recommended) / Ruta externa (sidecar compacto, recomendado):

./scripts/install-spec-sidecar.sh /absolute/path/to/project --profile=recommended
cd /absolute/path/to/project

Full standalone workspace only when explicitly needed / Workspace standalone completo solo cuando se necesite explícitamente:

./scripts/init-project.sh /absolute/path/to/project --profile=full
cd /absolute/path/to/project

3) Initialize Spec Kit (recommended) / Inicializa Spec Kit (recomendado)

uv tool install specify-cli --from git+https://github.com/github/spec-kit.git
specify init . --ai codex

One-shot / Uso puntual:

uvx --from git+https://github.com/github/spec-kit.git specify init . --ai codex

4) Define idea / Define idea

Complete idea/IDEA_GENERAL.md with:

  • Project name / Nombre
  • Problem / Problema
  • Main goal / Objetivo principal
  • MVP scope / Alcance MVP

5) Create first spec / Crea primera spec

./scripts/new-spec.sh "my-feature" "Owner"

Fill:

  • specs/001-.../spec.md
  • specs/001-.../plan.md
  • specs/001-.../tasks.md
  • specs/001-.../history.md

6) Apply SDD gate / Aplica compuerta SDD

No code before:

  • approved spec.md
  • consistent plan.md
  • explicit user consent recorded right before execution/implementation:
./scripts/confirm-user-consent.sh "User approved implementation for spec 001"

7) Validate + close session / Valida + cierra sesión

./scripts/validate-sdd.sh . --strict
./scripts/check-sdd-policy.sh .
./scripts/check-sdd-gate.sh .

Update:

  • bitacora/global/PROJECT_LOG.md
  • bitacora/diaria/AAAA-MM-DD.md
  • bitacora/handoffs/ (if pending work)

Next / Siguiente

  • AI detailed starter / Inicio IA detallado: AI_START_HERE.md
  • Command results reference / Referencia de resultados por comando: EN | ES
  • Beginner path / Ruta principiante: EN | ES
  • Prompt bank / Banco de prompts: EN | ES