Welcome. This directory complements the canonical artifacts at the repository root — it does not replace them and it does not restate normative requirements.
| File | What it is | Authority |
|---|---|---|
../spec.md |
The seed specification: 8 core roles, 5 extension roles, finding lifecycle, coordination substrate, ~130 functional requirements. | Normative for systems derived from the seed. |
../constitution.md |
11 inviolable principles. Each encodes a production failure that motivated it. | Wins against spec.md per Constitution §Precedence. |
../README.md |
How to turn the seed into your own system using spec-kit. | Operator-facing. |
../GLOSSARY.md |
Standalone glossary mirrored from spec.md §2. |
Reference. |
../CHANGELOG.md |
Version history of the seed itself. | Reference. |
If anything in docs/ conflicts with the artifacts above, the artifacts above are right and docs/ is wrong. Open an issue.
docs/
├── README.md ← you are here
├── faq.md ← curated adoption questions
├── adoption/ ← how to take the seed into a real org
├── architecture/ ← cross-role views, diagrams, flows
├── principles/ ← anti-patterns and field guide for the 11 principles
├── worked-examples/ ← concrete case studies (clarification, rule, evidence)
├── reference/ ← lookup tables (FR index, principle×FR matrix)
├── governance/ ← procedural how-to for amendments and versioning
└── operations/ ← organization-neutral implementation patterns
You are a security team lead deciding whether to adopt the seed.
../README.md(top to "Getting started")adoption/quickstart.mdworked-examples/example-clarification.mdfaq.md
You are running /speckit.clarify right now and need help answering markers.
adoption/clarification-playbook.mdadoption/integration-decisions.mdreference/open-questions-checklist.mdadoption/extension-roles-when.md
You are a platform engineer mapping the spec onto your stack.
architecture/role-interactions.mdarchitecture/finding-lifecycle.mdarchitecture/substrate-contracts.mdoperations/sandbox-patterns.mdoperations/observability-checklist.md
You are reviewing a plan.md or tasks.md PR and need to defend a principle.
You are a maintainer proposing a change to spec.md or constitution.md.
The seed README §"What the seed gives you, and what it does not" lists artifacts the adopter authors, not the seed:
- Detection rule corpus content.
- Cartographer document templates.
- Triager investigation procedure.
- Reporter writeup template & severity rubric.
- Hard-rules block beyond FR-111 minimums.
docs/ does not provide these and never will. They are organization- and target-specific by definition.
Also out of scope:
- API references — there is no API.
- Installation guides — there is nothing to install.
- Restatements of FRs or principles —
docs/cites; it does not normatively restate.
When contributing here:
- Cite, do not duplicate. Link to a spec section or FR rather than restating it. If the spec is unclear, fix the spec.
- Plain English first. Diagrams second. Tables for matrices.
- Mark the audience at the top of each file (operator? reviewer? platform engineer?).
- No prescription. This is a seed; an adopter's stack will differ. Provide options and decision criteria, not mandates.
- No new requirements. If a doc here would impose a new MUST/SHOULD/MAY, the requirement belongs in
spec.mdorconstitution.md, not indocs/.
See ../CONTRIBUTING.md for general contribution rules.