Blame
|
1 | # Wiki Governance |
||||||
| 2 | ||||||||
| 3 | The wiki is the human-readable knowledge layer for Soatrix. It is Git-backed so documentation changes have history, authorship and reversible revisions. |
|||||||
| 4 | ||||||||
| 5 | ## Source-of-truth hierarchy |
|||||||
| 6 | ||||||||
| 7 | Use this order when sources disagree: |
|||||||
| 8 | ||||||||
| 9 | 1. Running production behaviour and validated runtime configuration. |
|||||||
| 10 | 2. Merged source code and automated tests on the product's documented baseline branch/commit. |
|||||||
| 11 | 3. Product wiki reference pages. |
|||||||
| 12 | 4. Repository README files and release notes. |
|||||||
| 13 | 5. Planning documents, tickets, chat discussions and historical notes. |
|||||||
| 14 | ||||||||
| 15 | A lower source should be updated when it is proven stale; it should not be used to override a higher source silently. |
|||||||
| 16 | ||||||||
| 17 | ## Page lifecycle |
|||||||
| 18 | ||||||||
| 19 | Every substantive product area should be recognisable as one of four states: |
|||||||
| 20 | ||||||||
| 21 | - **Reference** — describes implemented behaviour. |
|||||||
| 22 | - **Runbook** — executable operational procedure. |
|||||||
| 23 | - **Decision** — durable architectural or policy rationale. |
|||||||
| 24 | - **Plan** — proposed/future work that is not yet a supported contract. |
|||||||
| 25 | ||||||||
| 26 | Avoid wording that makes a plan sound implemented. |
|||||||
| 27 | ||||||||
| 28 | ## Verification dates |
|||||||
| 29 | ||||||||
| 30 | Pages that describe fast-moving software should state the baseline used for verification. For repository-backed products, record the branch and abbreviated commit SHA near the top of the product's **Current Status** page. Do not place a mutable word such as “latest” in a durable page without a date or commit. |
|||||||
| 31 | ||||||||
| 32 | ## Changes |
|||||||
| 33 | ||||||||
| 34 | When a code change alters a documented contract, update the relevant wiki page in the same release/change window. Examples include: |
|||||||
| 35 | ||||||||
| 36 | - a new supported runtime version; |
|||||||
| 37 | - a command or permission change; |
|||||||
| 38 | - a configuration schema change; |
|||||||
| 39 | - a new content authoring field; |
|||||||
| 40 | - a different persistence or rollback guarantee; |
|||||||
| 41 | - a changed operational requirement. |
|||||||
| 42 | ||||||||
| 43 | ## Deleting and superseding pages |
|||||||
| 44 | ||||||||
| 45 | Prefer a short superseded page that links to the replacement when old links are likely to exist. Delete only when the page was erroneous, sensitive or has no useful historical navigation value. |
|||||||
| 46 | ||||||||
| 47 | ## Git safety |
|||||||
| 48 | ||||||||
| 49 | The wiki repository history may contain old text even after a page is edited. Never commit passwords, private keys, tokens, one-time secrets, database credentials or personal data that should not persist in Git history. Use a secrets manager or the relevant platform's protected configuration facility instead. |
|||||||