Commit 7a87e7e
authored
π [Docs]: Software design principles now cover smart defaults and local overrides (#14)
The software design principles now include **smart defaults, local
overrides** β how to set a safe, sensible default once at the broadest
scope and let it be overridden closer to the item it controls. Readers
and agents get a single principle to point at when deciding where a
setting belongs and how far a default should reach.
## New: "Smart defaults, local overrides" principle
Added under Software design, beside "Extensible by default". It states:
- The default is the smart, secure choice; a zero-config system is
already correct and safe. Configuration exists to *deviate* from a good
default, not to reach a usable one.
- Defaults are set at the broadest scope and overridden closer to the
item β the most specific setting wins, predictably by position in the
hierarchy, never by special-casing.
- The shape is chosen for long-term manageability: change the wide
default once and everything that has not opted out follows; deviating is
a small, local edit beside the item that needs it.
It consolidates ideas already in the docs rather than restating them β
cross-linking the Easy/Safe value, least-privilege, secure by default,
and the vision cascade.
## Technical Details
- `src/docs/Ways-of-Working/Principles/Software-Design.md` β new `##
Smart defaults, local overrides` section plus an updated front-matter
`description`.
- `src/docs/Ways-of-Working/Principles/index.md` β Software design row
updated to match the new description, keeping the auto-generated index
in sync (`Update-DocumentationIndex.ps1 -Check` passes).
- Quality gates green locally: markdownlint, textlint, codespell,
documentation link check, and index-drift check.1 parent f45e0a0 commit 7a87e7e
2 files changed
Lines changed: 24 additions & 2 deletions
Lines changed: 23 additions & 1 deletion
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | 1 | | |
2 | 2 | | |
3 | | - | |
| 3 | + | |
4 | 4 | | |
5 | 5 | | |
6 | 6 | | |
| |||
19 | 19 | | |
20 | 20 | | |
21 | 21 | | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
| 36 | + | |
| 37 | + | |
| 38 | + | |
| 39 | + | |
| 40 | + | |
| 41 | + | |
| 42 | + | |
| 43 | + | |
22 | 44 | | |
23 | 45 | | |
24 | 46 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
15 | 15 | | |
16 | 16 | | |
17 | 17 | | |
18 | | - | |
| 18 | + | |
19 | 19 | | |
20 | 20 | | |
21 | 21 | | |
| |||
0 commit comments