Skip to content

d0whc3r/spec-kit-product

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

146 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Product Spec Extension for Spec Kit

A Spec Kit extension that derives four stakeholder-facing artifacts from a technical spec.md and plan.md. Output follows Amazon Working Backwards (PRFAQ), Jobs to Be Done (Ulwick), Gherkin BDD, and Lean PRD conventions, in plain English, with a strict no em dash style.

Documentation

The full guide lives in the project wiki. This README is the front door only.

Wiki page When to read
Home Overview and reading order.
Getting Started First install, zero to first generated artifact in five minutes.
Commands Deep reference for the four /speckit.product.* commands.
Workflow Input and output flow, recommended order, the product/ layout.
Examples Sample spec.md input and the four artifacts it produces.
Style Guide The voice rules every generated artifact enforces.
Diagrams How diagrams and optional sections are generated, and the value gate.
Troubleshooting Error codes, refusals, common breakages and their fixes.
FAQ Conceptual questions and design rationale.
Architecture How the extension works when you run a command.

The wiki is generated from docs/ on every push to main. To browse the same content as plain markdown, open the docs folder.

At a glance

Command Reads Writes Audience
/speckit.product.info spec.md product/00-info.md Any stakeholder, non-technical
/speckit.product.spec spec.md product/10-spec.md Product managers, leadership
/speckit.product.plan plan.md, spec.md product/20-plan.md PMs, engineering leads
/speckit.product.design plan.md, spec.md, optional more product/30-design.md Tech leads, senior developers

All four commands also update their respective section of the shared product/checklist.md. No command modifies spec.md or plan.md.

Source of truth

spec.md and plan.md are canonical. Everything under product/ is a derived view, regenerated on demand by rerunning the matching command and choosing overwrite. [NEEDS CLARIFICATION] markers in spec.md are surfaced as open product questions in the generated output, never silently resolved.

Install

Install directly from the latest release. This needs no catalog setup and is the recommended path:

specify extension add product --from https://github.com/d0whc3r/spec-kit-product/releases/download/v0.8.1/product-0.8.1.zip

Change the version in the URL to pin a different release.

Want to install by name with specify extension add product? That resolves the extension from Spec Kit's community catalog, which ships as discovery only (install_allowed: false). Approve it once:

specify extension catalog add https://raw.githubusercontent.com/github/spec-kit/main/extensions/catalog.community.json --name community --install-allowed
specify extension add product

If specify extension add product fails with installation is not allowed from that catalog, that is why. See Troubleshooting.

For prerequisites and the first-run walkthrough see Getting Started.

Contributing

See CONTRIBUTING.md at the repo root.

License

MIT. See LICENSE.