- template-target
- {{codebase}}Impl
- template-levels
- template-note
- not made at project creation (P-605): a code base's notes topic, made when someone starts building {{project}} in a code base (e.g. Proto1Impl); its companions …Code, …Routes, …Test are made with it
- description
- How the {{codebase}} code base met the design of {{project}}, per feature, with notes for later builds
- tags
- #ai #impl
- status
- draft
{{project}}: {{codebase}} as built¶✎ edit
This is {{codebase}}Impl, kept by the {{codebase}} builders: per feature (the same {#id} as in Design), how {{codebase}} met the design, where it differs and why, the builders' small decisions, and notes for the next implementation. Each entry names its item, e.g. (P-12). No code references and no version numbers: files, classes, releases and deploys are in {{codebase}}Code. Its companions: Spec (what it does), SpecUi (how the UI behaves), Design (the mechanisms), DesignRoutes (the API) and SpecTest (the black-box tests); each code base that builds {{project}} keeps its own topics, named after it (e.g. Proto1Impl, Proto1Code, Proto1Routes, Proto1Test).
Goals¶✎ edit
- Role: what was built and why, readable without opening the code.
- A line belongs here if a later build of {{project}} would want to know it.
- It fails if it names files, classes or commits, or if a builder changed Design instead of writing here what couldn't be built as designed.