What problem does it solve?
This Skill addresses the challenge of maintaining comprehensive documentation for specifications by separating normative requirements from essential narrative context, ensuring clarity and accessibility for all stakeholders.
Core Features & Use Cases
- Two-Layer Documentation: Enforces a clear distinction between testable requirements (
spec.md) and supporting narrative context (e.g., context.md, rationale.md).
- Contextual Enrichment: Guides the inclusion of purpose, rationale, constraints, examples, and operational notes to aid understanding.
- Use Case: When developing a new API specification, use this Skill to ensure that not only are the endpoints and parameters defined in
spec.md, but also the design decisions, security considerations, and example request/response payloads are captured in context.md.
Quick Start
Use the openspec-context-docs skill to update the context documentation for a new API specification, ensuring it includes purpose, rationale, and at least one example.