spec-writing
This skill should be used when the user asks to "create a spec", "write a specification", "review a spec", "update a spec", "review spec organization", "split a spec", "add a page to spec", "remove a page from spec", "move requirements between pages", "add requirements", "review requirements", "update requirements", "delete requirements", "add tests", "add test cases", "review tests", "update tests", "delete tests", or needs guidance on spec structure, formatting, or spec writing best practices.
When & Why to Use This Skill
The spec-writing skill is a comprehensive professional tool designed to streamline the creation, review, and optimization of technical specifications. It provides structured guidance on requirement engineering, document formatting, and test case design, ensuring that technical documentation is clear, authoritative, and aligned with industry best practices for software development and systems engineering.
Use Cases
- Drafting comprehensive technical specifications for new software components, systems, or internal processes from scratch.
- Reviewing and refining existing requirements to ensure they are clear, measurable, and free of ambiguity.
- Designing detailed test cases and validation criteria based on defined system behaviors and functional requirements.
- Restructuring and organizing complex specification documents to improve readability and logical flow.
- Updating legacy documentation to reflect new features, architectural changes, or updated compliance standards.
- Providing expert guidance on technical writing best practices and standardized formatting for engineering teams.
| name | spec-writing |
|---|---|
| description | This skill should be used when the user asks to "create a spec", "write a specification", "review a spec", "update a spec", "review spec organization", "split a spec", "add a page to spec", "remove a page from spec", "move requirements between pages", "add requirements", "review requirements", "update requirements", "delete requirements", "add tests", "add test cases", "review tests", "update tests", "delete tests", or needs guidance on spec structure, formatting, or spec writing best practices. |
| version | 0.1.0 |
Specification writing
This skill provides guidance for creating, reviewing, and improving technical specifications. It includes progressively-disclosed references on spec structure, formatting, requirement writing, test case design, and best practices for clear and effective specification documents.
About specifications
Specifications define formal requirements, behaviors, and interfaces for components, systems, or processes. They serve as authoritative references for development, testing, and validation activities.
Steps
MANDATORY STEPS FOR ALL SPEC WRITING TASKS
Gather context - Run
oaps skill orient spec-writingto see available referencesIdentify relevant references - Review the references table from step 1 and select those matching your task
Load dynamic context and references - Run
oaps skill context spec-writing --references <names...>Review loaded references and commands - Read through the guidance. The Allowed commands table at the end of the output is authoritative for what commands can be run.
Follow the workflow - Adhere to the selected workflow's steps for structuring, writing, reviewing, or improving the specification.