AgentSkillsCN

vibeflow-feature-spec

为VibeFlow文档优先型工作流的E阶段创建功能规格说明书

SKILL.md
--- frontmatter
name: vibeflow-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

vibeflow-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

Triggers

Use this skill when:

  • User asks to "create feature spec", "write feature", "design feature"
  • User asks for "acceptance criteria", "API design"
  • User mentions "Stage E", "feature planning"
  • After completing planning phase (Stages A-D)

Usage

Create Feature Spec

code
/vibeflow-feature-spec <ID> <slug>

Creates docs/features/ft-<ID>-<slug>.md with required sections.

Example:

code
/vibeflow-feature-spec 030 anti-hallucination

Validate Feature Spec

code
/vibeflow-feature-spec validate <ID>

Validates that the feature spec has all required sections.

Update Schedule

code
/vibeflow-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"
    }
    
code

**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

  • scripts/validate_feature.py — Validate feature spec structure and API Design

Templates

See references/:

  • feature-template.md — Complete feature spec template
  • api-design-guide.md — API Design section guidance

Checkpoint #2

After completing Stage E, validate with:

code
/vibeflow-validate checkpoint 2

This validates:

  • Feature spec exists with all sections
  • API Design has exact signatures
  • Acceptance criteria are testable
  • Links to TECH-SPECs with versions