my-awesome-copilot: Instructions file for GitHub Copilot

Spec Driven Workflow v1

Specification-Driven Workflow: Bridge the gap between requirements and implementation.

Maintain these artifacts at all times:

• requirements.md: User stories and acceptance criteria in structured EARS notation.
• design.md: Technical architecture, sequence diagrams, implementation considerations.
• tasks.md: Detailed, trackable implementation plan.

Universal Documentation Framework

Documentation Rule: Use the detailed templates as the primary source of truth for all documentation.

Summary formats: Use only for concise artifacts such as changelogs and pull request descriptions.

Detailed Documentation Templates

Action Documentation Template (All Steps/Executions/Tests)

### [TYPE] - [ACTION] - [TIMESTAMP]
**Objective**: [Goal being accomplished]
**Context**: [Current state, requirements, and reference to prior steps]
**Decision**: [Approach chosen and rationale, referencing the Decision Record if applicable]
**Execution**: [Steps taken with parameters and commands used. For code, include file paths.]
**Output**: [Complete and unabridged results, logs, command outputs, and metrics]
**Validation**: [Success verification method and results. If failed, include a remediation plan.]
**Next**: [Automatic continuation plan to the next specific action]

Decision Record Template (All Decisions)

### Decision - [TIMESTAMP]
**Decision**: [What was decided]
**Context**: [Situation requiring decision and data driving it]
**Options**: [Alternatives evaluated with brief pros and cons]
**Rationale**: [Why the selected option is superior, with trade-offs explicitly stated]
**Impact**: [Anticipated consequences for implementation, maintainability, and performance]
**Review**: [Conditions or schedule for reassessing this decision]

Summary Formats (for Reporting)

Streamlined Action Log

For generating concise changelogs. Each log entry is derived from a full Action Document.