speckit-plan

Generate research, data-model, contracts, and quickstart artifacts from feature specifications.

60|12|Updated Aug 1, 2013
One-click install
npx skills add https://github.com/vtex/front.phone --skill speckit-plan-vtex
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: speckit-plan
Source: https://github.com/vtex/front.phone/tree/main/.agents/skills/speckit-plan
Command: npx skills add https://github.com/vtex/front.phone --skill speckit-plan-vtex

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Speckit-plan turns an implementation spec into a structured set of design and research artifacts while enforcing gate checks and consistency with the project’s constitution.

Core Features & Use Cases

  • Generates a full implementation plan: produces research.md, data-model.md, /contracts/*, and quickstart.md based on a plan template and the project constitution.
  • Resolves unknowns with research tasks: finds NEEDS CLARIFICATION items and converts them into research work, ensuring they are addressed before design outputs.
  • Supports extension hooks safely: optionally runs registered hooks.before_plan and hooks.after_plan commands from .specify/extensions.yml with dot-to-hyphen command mapping.

Quick Start

Ask the AI to run the speckit-plan workflow for your repository to generate research.md, data-model.md, contracts, and quickstart.md.

Frequently Asked Questions about speckit-plan

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate design artifacts from a feature specification?▼

To generate design artifacts from a feature specification, you execute an implementation planning workflow that produces research.md, data-model.md, contracts, and quickstart.md based on an IMPL_PLAN template and project constitution checks.

What's the best way to resolve NEEDS CLARIFICATION items in an implementation plan?▼

Resolving NEEDS CLARIFICATION items requires converting them into research tasks during Phase 0 generation, ensuring unknowns are addressed before creating Phase 1 design outputs like data models and contracts.

Does spec-kit support custom extension hooks during implementation planning?▼

Spec-kit supports custom extension hooks by optionally running registered hooks.before_plan and hooks.after_plan commands from .specify/extensions.yml, applying dot-to-hyphen command mapping for safe execution.

How do I enforce constitution checks when planning software components?▼

Constitution checks are enforced during implementation planning by validating phased design outputs against the project constitution, ensuring research and contract generation adhere to predefined guardrails.

Can I use speckit-plan in repositories without a setup script?▼

No, speckit-plan requires running a setup script first to obtain FEATURE_SPEC, IMPL_PLAN, SPECS_DIR, and BRANCH variables, making it applicable only to spec-kit based repositories with this environment configured.