Skip to content

Latest commit

 

History

History
38 lines (28 loc) · 1.08 KB

File metadata and controls

38 lines (28 loc) · 1.08 KB
name docs-spec
description Use when work needs explicit scope, scenarios, constraints, and verifiable acceptance criteria before implementation.

Spec Context

Use when execution depends on explicit scope, scenarios, constraints, and verifiable success criteria.

Destination

  • docs/specs/YYYY-MM-DD-<slug>.md

Use For

  • functional changes that need clear boundaries
  • behavior that should be testable before implementation starts
  • user, system, or business scenarios that drive the work
  • acceptance criteria that should guide planning and delivery

Output Shape

  1. Problem or opportunity
  2. Objective
  3. Scope
  4. Non-goals
  5. Constraints and assumptions
  6. Key scenarios or flows
  7. Acceptance criteria
  8. Open questions

Rules

  • Keep the spec lean and execution-oriented.
  • Make criteria observable and testable.
  • Prefer one clear spec over scattered notes and meeting leftovers.
  • Do not turn brainstorming or temporary planning notes into durable spec content unless they will matter later.
  • If the repo already has a live spec, update it instead of opening a new one.