Specifications
All design documentation for AI Platform Engineering (CAIPE) lives here β feature specifications, implementation plans, and architecture decision records (ADRs).
Structureβ
| Directory | Contents | Naming Convention |
|---|---|---|
<YYYY-MM-DD-feature-name>/ | Feature specs, plans, tasks, contracts | Date-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β
- Run
/speckit.specify <description>β createsdocs/docs/specs/<YYYY-MM-DD-short-name>/(todayβs date + short name) - Fill in the spec template with overview, user stories, acceptance criteria
- Run
/speckit.planto create the implementation plan - Run
/speckit.tasksto create the task breakdown
Adding a Change Record (ADR)β
- Create a file in
changes/:YYYY-MM-DD-short-descriptive-name.md - Start with a level-one heading:
# Title of the change - New files appear automatically in the sidebar