create-feature-spec
Scannednpx machina-cli add skill hardness1020/VibeFlow/create-feature-spec --openclawcreate-feature-spec
Create Feature Specs for Stage E of the VibeFlow docs-first workflow.
Purpose
This skill creates Feature Spec documents that:
- Define the API design contract (exact function/class signatures)
- Specify testable acceptance criteria
- Document design changes (UI/API/schema)
- Include test and evaluation plan
- Reference discovery findings and specs
Workflow
Stage E: Feature Spec
│
├── Define API Design (exact signatures)
├── Write testable acceptance criteria
├── Document design changes (UI/API/schema)
├── Create test and evaluation plan
├── Map telemetry and metrics
└── Reference discovery findings and specs
Usage
Create Feature Spec
/create-feature-spec <ID> <slug>
Creates docs/features/ft-<ID>-<slug>.md with required sections.
Example:
/create-feature-spec 030 anti-hallucination
Validate Feature Spec
/create-feature-spec validate <ID>
Validates that the feature spec has all required sections.
Update Schedule
/create-feature-spec schedule
Updates docs/features/schedule.md with feature status.
Document Requirements
Required Sections
For All Features:
- Header (ID, File, Owner, TECH-SPECs with versions)
- Architecture Conformance
- API Design (exact signatures)
- Acceptance Criteria
- Design Changes
- Test & Eval Plan
- Telemetry & Metrics
- Edge Cases & Risks
For Medium/Large Features (Additional):
- Stage B Discovery Findings
- Test Impact Analysis
- Existing Implementation Analysis
- Dependency & Side Effect Mapping
API Design Section (Critical)
The API Design section defines the contract for Stage F (test writing):
## API Design
### ServiceName.method_name()
- **Signature:** `method_name(param: Type, param2: Type = default) -> ReturnType`
- **Purpose:** [Brief description]
- **Parameters:**
- `param`: [Description]
- `param2`: [Description, default value]
- **Returns:** [Description of return type and structure]
### API Endpoint: POST /api/v1/endpoint
- **Method:** POST
- **Path:** `/api/v1/endpoint`
- **Request Body:**
```json
{
"field": "type"
}
- Response Body:
{ "result": "type" }
Why This Matters:
- Stage F creates implementation stubs from these signatures
- Tests are written using these exact function names
- Any changes require updating specs first (Stage G.1)
Acceptance Criteria
Format as testable checklist or Gherkin:
## Acceptance Criteria
- [ ] User can [action] with [condition] resulting in [outcome]
- [ ] System returns [response] when [condition]
- [ ] Error [X] is shown when [condition]
Or Gherkin:
Given [context]
When [action]
Then [expected outcome]
Validation
scripts/validate_feature.py— Validate feature spec structure and API Design
References
See assets/:
feature-template.md— Complete feature spec template
See references/:
api-design-guide.md— API Design section guidance
Manifest Update
After completing Stage E, update docs/workflow-state.yaml:
- Set
stage: E - Set
docs.feature: docs/features/ft-<ID>-<slug>.md
Checkpoint #2 (after Stage E):
- Set
checkpoint: 2after passing validation - Criteria: Feature spec exists with all required sections, API Design section has exact signatures, acceptance criteria are testable
To advance to the next stage: /manage-work advance <ID>
To check readiness: /validate-checkpoint 2
Source
git clone https://github.com/hardness1020/VibeFlow/blob/main/.claude/skills/create-feature-spec/SKILL.mdView on GitHub Overview
This skill generates Feature Spec documents for Stage E in the VibeFlow docs-first workflow. It ensures the API design contract, acceptance criteria, design changes, test/evaluation plan, telemetry mapping, and references to discovery findings are captured in a standardized docs/features/ft-<ID>-<slug>.md.
How This Skill Works
The skill creates docs/features/ft-<ID>-<slug>.md with all required sections, including API Design (exact signatures), Acceptance Criteria, Design Changes, and Test & Eval Plan. It supports validation and scheduling commands to progress Stage E and references discovery findings and specs.
When to Use It
- When you need to define the API design contract with exact signatures for a new feature
- When you must write testable acceptance criteria aligned to edge cases and requirements
- When you need to document UI/API/schema design changes in a standardized spec
- When you must create a test and evaluation plan for feature validation
- When you need to map telemetry/metrics and reference discovery findings in the spec
Quick Start
- Step 1: /create-feature-spec <ID> <slug> to generate docs/features/ft-<ID>-<slug>.md
- Step 2: Fill required sections: Header, Architecture Conformance, API Design, Acceptance Criteria, Design Changes, Test & Eval Plan, Telemetry & Metrics, Edge Cases & Risks (and Stage B findings if large feature)
- Step 3: /create-feature-spec validate <ID> to verify completeness and API Design exact signatures
Best Practices
- Ensure API Design includes exact function/method signatures and returns
- Write acceptance criteria as testable items or Gherkin scenarios
- Document design changes (UI/API/schema) clearly within the feature spec
- Reference Stage B/C findings or discovery results where relevant
- After Stage E, update docs/workflow-state.yaml with proper stage and checkpoint
Example Use Cases
- /create-feature-spec 030 anti-hallucination
- /create-feature-spec validate 030
- Update docs/workflow-state.yaml after Stage E to set stage: E and feature path
- Create a feature spec for a new API endpoint and ensure exact signatures are documented
- Link discovery findings in Stage E to support API design decisions