idclear requirements
This wiki is the canonical requirements set for idclear. Every page is a Markdown file in the private repository idclear/requirements; the same folder opens as an Obsidian vault. Only documents with status Approved are built against.
Reading paths
| Reader | Start with | Then |
|---|---|---|
| Co-founder or adviser | The explainers (OW-010, RE-010) | The business requirements and user stories (OW-020, RE-020) |
| Developer | The conventions (OW-000, RE-000) and skeletons (OW-001, RE-001) | The TRD for the area being built, and the reference-data specification (OW-400) |
| Agent checking the build | OW-000 section 3, RE-000 section 3 | Every TRD; the requirement index and /ids.json |
| Reviewer | The page under review | The decision register for open decisions |
How to review
- Comment on a requirement. Every requirement, decision and dataset has a small Comment button beside its identifier. It opens a GitHub issue already filled in with the document, version, identifier and page. Write the comment and submit.
- Comment on a page. Use Comment on this page under the title.
- Comment on a draft. Drafts arrive as pull requests with a preview link. Comment on the lines in the pull request’s Files changed tab, or use the Comment buttons on the preview.
- Approval is the document owner’s merge of the pull request. Nothing reaches this site without it.
Registers
Generated from the documents on every build: documents, requirements, decisions and departures, all identifiers and unresolved references. Every identifier mentioned anywhere in the set links to its definition.
Status legend
Draft (being written), Review (circulated for challenge), Approved (baseline for build), Superseded (replaced). Pages under Sources and Worklog are context and records, never baseline.