product-description
Installation
SKILL.md
Product description repo
A product description treats the product as a large state chart the user moves through with input. The repo describes that state chart feature by feature, in plain language, from the user's point of view, with the same skeleton for every document so that gaps and inconsistencies show up by comparison. Documents are drafted from the source code and its tests, then verified by hand against the running product, and everything that looks like a defect is collected into one triage file.
The files under references/:
| File | What it is |
|---|---|
product-kinds.md |
How to map the template onto a canvas editor, a web app, a CLI, or a chat product. Read in Phase 0. |
README-template.md, goal-template.md, glossary-guide.md |
Skeletons for the three files that steer the whole build. |
document-template.md |
The eight-section skeleton every feature document follows. |
verification-template.md, bug-triage-template.md |
Skeletons for the checking half. |
check-links.py |
Link and anchor checker for the consistency pass. python3 check-links.py {repo}. |