Skip to main content

Specifications

All design documentation for AI Platform Engineering (CAIPE) lives here β€” feature specifications, implementation plans, and architecture decision records (ADRs).

Structure​

DirectoryContentsNaming Convention
<YYYY-MM-DD-feature-name>/Feature specs, plans, tasks, contractsDate-prefixed folder name (same date as branch prefix from /speckit.specify)
changes/Architecture Decision Records (ADRs)Date-prefixed (YYYY-MM-DD-<slug>.md)

Spec-Kit Workflow​

New feature specs are created using the spec-kit commands:

/speckit.specify <description>   # β†’ docs/docs/specs/<YYYY-MM-DD-slug>/spec.md
/speckit.plan <tech choices> # β†’ docs/docs/specs/<YYYY-MM-DD-slug>/plan.md
/speckit.tasks # β†’ docs/docs/specs/<YYYY-MM-DD-slug>/tasks.md
/speckit.implement # Execute tasks against the plan

Spec Directory Layout​

Each numbered spec directory can contain:

docs/docs/specs/<YYYY-MM-DD-feature-name>/
β”œβ”€β”€ spec.md # Feature specification (PRD)
β”œβ”€β”€ plan.md # Implementation plan
β”œβ”€β”€ tasks.md # Executable, dependency-ordered task list
β”œβ”€β”€ research.md # Technical research (library choices, benchmarks)
β”œβ”€β”€ data-model.md # Entity and schema definitions
β”œβ”€β”€ contracts/ # API contracts, event schemas
└── quickstart.md # Key validation scenarios

Adding a New Spec​

  1. Run /speckit.specify <description> β€” creates docs/docs/specs/<YYYY-MM-DD-short-name>/ (today’s date + short name)
  2. Fill in the spec template with overview, user stories, acceptance criteria
  3. Run /speckit.plan to create the implementation plan
  4. Run /speckit.tasks to create the task breakdown

Adding a Change Record (ADR)​

  1. Create a file in changes/: YYYY-MM-DD-short-descriptive-name.md
  2. Start with a level-one heading: # Title of the change
  3. New files appear automatically in the sidebar