speckit-plan

Generate design artifacts from a plan template in .specify projects.

Updated Nov 23, 2023

Search Tags:#automation #workflow #planning #templates #hooks #speckit #design-artifacts

Ready to run

npx skills add https://github.com/auleewilliams/Skillscape --skill speckit-plan-auleewilliams

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: speckit-plan
Source: https://github.com/auleewilliams/Skillscape/tree/main/.claude/skills/speckit-plan
Command: npx skills add https://github.com/auleewilliams/Skillscape --skill speckit-plan-auleewilliams

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Speckit-plan automates the execution of the implementation planning workflow using a plan template to generate design artifacts, reducing manual planning effort and ensuring consistency across projects.

Core Features & Use Cases

Plan-template driven workflow that generates research.md, data-model.md, contracts/, quickstart.md.
Pre- and post-execution hooks support via .specify/extensions.yml with robust handling and filtering.
End-to-end planning phases, artifact generation, and agent-context updates, with deterministic steps and clear governance.
Built for projects following the .specify structure to streamline design work.

Quick Start

Provide a SPEC template and run the speckit-plan workflow to generate the design artifacts.

Frequently Asked Questions about speckit-plan

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

FAQPage Schema

How do I automate generating design artifacts like research and data models for implementation planning?▼

Automating design artifact generation requires a plan-template driven workflow that produces research.md, data-model.md, and contracts from a provided SPEC template. This enforces deterministic planning steps with pre- and post-execution hooks to reduce manual effort and ensure consistency.

What are pre- and post-execution hooks in a planning workflow and how do they work?▼

Pre- and post-execution hooks are extension points configured via .specify/extensions.yml that run before and after planning phases. They provide robust handling and filtering to enforce deterministic steps and clear governance throughout the artifact generation process.

How do I generate design artifacts for a project structured with the .specify directory?▼

To generate design artifacts for a .specify directory project, provide a SPEC template and execute the planning workflow. This targets the specific project structure to produce research.md, data-model.md, contracts/, and quickstart.md automatically.

Does the planning workflow require a specific directory structure to generate contracts and data models?▼

Yes, the planning workflow is built for projects following the .specify directory structure. It requires this specific environment to properly execute the plan template and generate the associated design artifacts.

What happens when there are unresolved clarifications during the design artifact generation process?▼

When unresolved clarifications occur during artifact generation, the workflow enforces strict error handling. It halts the deterministic planning phases rather than proceeding with incomplete or ambiguous specifications.

Can I use custom plan templates to generate quickstart and contract files for my software project?▼

Yes, you can provide a SPEC template to drive the workflow, which generates quickstart.md, contracts, and other design artifacts. The plan-template driven approach streamlines design work while maintaining consistency across projects.