docs: one owner for the one-log rule, and an honest scope on the census
The one-work-log rule was written near-verbatim in four places — okf-spec, okf-maintenance, log.md's preamble, and APPEND_SYSTEM.md. Four copies is four authorities: each can be edited alone, and the next reader cannot tell which one the linter implements. okf-spec.md owns it; maintenance now carries the action (collapse a second log into the root, then re-run the linter) instead of re-arguing it; the log page points at the rule rather than restating it. APPEND_SYSTEM keeps its imperative — a system prompt cannot fetch a link at the moment of writing — but no longer carries the duplicated reasoning. `inventory/index.md` advertised "all userspace program configuration on the workstation". The one page in that directory measures `~/.config` on blankpad: not `~/.local/share`, not system package state, not the servers. A coverage claim that names what was measured is the difference between a census and an alibi. Refs #60
This commit is contained in:
1 parent
a280c29d2c
commit
66e1129e6c
4 files changed
+23
-11
No files matched your search
@@ -72,7 +72,7 @@ Documentation exists for ONE reason: **point of use**. A page earns its bytes on
|
||||
#### THE WORK LOG IS ONE FILE.
|
||||
The work log is a single page in the knowledge base: `omp-docs/log.md` in this repo, or whichever change-log page the repo's docs index names. Write the entry when the change lands — in the same commit as the change — and read that page to recover where things stand before starting. It follows its own entry law: a dated entry is what changed plus the durable lesson, a few lines.
|
||||
|
||||
- NEVER create a second log: not per directory, not per project, feature, branch or run, not `NOTES.md` / `PROGRESS.md` / `STATUS.md` / `worklog/`, not a dated diary. Logging in fifty places is not logging — the entry is never where the next reader looks, and each copy re-dates the same event on its own authority. In `dank/command-center` the KB linter reports any `log.md` that is not the bundle root's.
|
||||
- NEVER create a second log: not per directory, not per project, feature, branch or run, not `NOTES.md` / `PROGRESS.md` / `STATUS.md` / `worklog/`, not a dated diary. In `dank/command-center` the KB linter reports any `log.md` that is not the bundle root's; the rule and its reasoning are owned by `omp-docs/references/okf-spec.md`.
|
||||
- A log holds laws and incidents, never bookkeeping: no per-file inventories, no run-by-run numbers, no transcripts. A number in a log still has to pass the purpose test above.
|
||||
- If a knowledge base has no log page, add one at its root and list it in the index. That is the fix — never a log somewhere else.
|
||||
|
||||
|
||||
Reference in new issue
Block a user