Skip to content
Back to skills

Create Feature Spec

ASecurity

Create Feature Specs for Stage E of the VibeFlow docs-first workflow

  • 8 stars
  • 0 votes
  • 0 copies
  • 2 views
  • Added May 26, 2026
documentationbashgitapidocumentation

Works with

  • api

Security analysis

A100/100

Pro scans all 4 files and shows the line behind each finding

Scanned May 27, 2026

npx -y skills add hardness1020/VibeFlow --skill create-feature-spec --agent claude-code

Installs into .claude/skills of the current project.

Are you the author of Create Feature Spec?

Add the live security badge to your README. It updates with every re-scan.

Security grade badge for Create Feature Spec
[![Security: A — Skills Directory](https://www.skillsdirectory.com/api/skills/hardness1020-create-feature-spec/badge)](https://www.skillsdirectory.com/skills/hardness1020-create-feature-spec)

More formats (shields.io, HTML) on the badges page. Keep it an A: scan every change in CI with Pro.

Download with Pro
SKILL.md
---
name: create-feature-spec
description: Create Feature Specs for Stage E of the VibeFlow docs-first workflow
metadata:
  triggers:
    - create feature spec
    - write feature
    - design feature
    - acceptance criteria
    - API design
    - Stage E
    - feature planning
---

# create-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):

```markdown
## 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:**
  ```json
  {
    "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:

```markdown
## 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

## Context7 Library Research

Follow the workflow in `.claude/rules/context7-research.md` to fetch current library documentation.

**What to look for:** exact method signatures, error types, configuration options, parameter defaults.

**Where to incorporate findings:**
- **API Design** — use verified signatures and types from library docs, not assumed ones
- **Acceptance Criteria** — reference actual error types and edge cases from docs
- **Edge Cases & Risks** — document known limitations and version-specific behaviors

## 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: 2` after passing validation
- Criteria: Feature spec exists with all required sections, API Design section has exact signatures, acceptance criteria are testable

## Git Commit

After completing this stage, ask the user for permission before committing:

```bash
git add docs/features/ft-<ID>-<slug>.md docs/workflow-state.yaml
git commit -m "feat(feature): define <slug> feature spec (#ft-<ID>)"
```

Replace `<ID>` and `<slug>` with actual values.

## Auto-Advance

After the commit is complete, directly run `/manage-work advance <ID>` to advance to the next stage.
The advance command will automatically validate Checkpoint #2 at the E→F boundary.

Files in this skill

  • SKILL.md4.6 KB
  • assets/feature-template.md4.7 KB
  • references/api-design-guide.md6.3 KB
  • scripts/validate_feature.py11.1 KB

Attribution

Is this your skill, or is something wrong with this listing? Request removal or report an issue. Author removals are honored within 72 hours.

Comments

Loading comments…

Newsletter

Get the weekly list of safe new skills, and the ones we pulled.