Skip to content

SPEC_TEMPLATE.md

Latest commit

 

History

History
74 lines (46 loc) · 1.57 KB

SPEC_TEMPLATE.md

File metadata and controls

74 lines (46 loc) · 1.57 KB
Raw

Spec: [Title]

Author: [name] Status: Draft | In Review | Approved | Implemented Created: YYYY-MM-DD Updated: YYYY-MM-DD Canonical TODO Ledger: agent.todo.md GitHub Tracking: [repo/issues or project link]

Summary

One paragraph describing what this spec defines.

Motivation

Why is this spec needed? What problem does it solve?

Detailed Design

[Section 1]

...

[Section 2]

...

Multi-Agent Coordination

Artifact Owner Agent Lock Required Handoff Notes
[path] [agent-id] Yes/No [notes]

GitHub Traceability

Spec Item Requirement ID GitHub Issue/PR Status
[item] [REQ-###] [#123] Draft/In Progress/Done

Design Readiness Gate (Pre-Coding)

Checkpoint Status (Done/Deferred/Open) Owner Evidence
Architecture pattern Open
Language/runtime Open
Database strategy Open
Logging/observability baseline Open

Coding start rule:

  • Do not open implementation tasks until required checkpoints are resolved or explicitly deferred.

Acceptance Criteria

  • Criterion 1
  • Criterion 2

Out of Scope

What this spec explicitly does NOT cover.

Dependencies

Other specs, ADRs, or external systems this depends on.

Open Questions

  • Question 1?
  • Question 2?

RCA Considerations

  • If this spec mitigates an incident, link the RCA document and corrective actions.