| |
| fxdemo:04-part:15-phase-0-developer-handbook-requirements:15-2-purpose-of-the-developer-handbook:start [2026/08/03 16:31] – created owen | fxdemo:04-part:15-phase-0-developer-handbook-requirements:15-2-purpose-of-the-developer-handbook:start [2026/08/03 16:37] (current) – owen |
|---|
| The handbook must help contributors: | The handbook must help contributors: |
| |
| * Create files with consistent headers and [[dido:99_annexes:annex-b-terms-and-definitions:t:traceability|Traceability]] metadata | - Create files with consistent headers and [[dido:99_annexes:annex-b-terms-and-definitions:t:traceability|Traceability]] metadata |
| * Distinguish generated artifacts from hand-authored artifacts | - Distinguish generated artifacts from hand-authored artifacts |
| * Follow approved naming conventions | - Follow approved naming conventions |
| * Follow approved coding style | - Follow approved coding style |
| * Use logging consistently | - Use logging consistently |
| * Handle exceptions consistently | - Handle exceptions consistently |
| * Preserve [[dido:99_annexes:annex-b-terms-and-definitions:r:runtime_plane|Runtime Plane]] distinctions in implementation behavior | - Preserve [[dido:99_annexes:annex-b-terms-and-definitions:r:runtime_plane|Runtime Plane]] distinctions in implementation behavior |
| * Follow repository workflow | - Follow repository workflow |
| * Run approved scripts correctly | - Run approved scripts correctly |
| * Avoid uncontrolled prototype code | - Avoid uncontrolled prototype code |
| * Prepare artifacts for later deployment, testability, observation, and [[dido:99_annexes:annex-b-terms-and-definitions:e:evidence|Evidence]] planning | - Prepare artifacts for later deployment, testability, observation, and [[dido:99_annexes:annex-b-terms-and-definitions:e:evidence|Evidence]] planning |
| |
| The handbook turns implementation discipline into repeatable developer practice. | The handbook turns implementation discipline into repeatable developer practice. |