From 59920f849de495df3fae11d96d5a7fecabb589c8 Mon Sep 17 00:00:00 2001 From: Frank Date: Tue, 20 Oct 2026 21:49:16 -0700 Subject: [PATCH] docs(agent): re-add the work-log rule, restricted to one file MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Rule 1 lost its work-log sentence in the point-of-use rewrite. Restoring it plainly would re-create the old failure, where one agent kept logs in fifty-odd files and none of them was the place to look. So the restored rule names the file: a single page in the knowledge base — omp-docs/log.md here, whichever change-log page a repo's index names elsewhere — read before starting, written in the same commit as the change it describes, under that page's own entry law. Explicitly banned: per-directory logs, per-project or per-run logs, NOTES.md/PROGRESS.md/STATUS.md/worklog/, dated diaries. If a KB has no log page, the fix is one at its root plus an index entry, never a log somewhere else. The bundle's own log records the change and the two-log incident it came out of. --- agent/APPEND_SYSTEM.md | 7 +++++++ omp-docs/log.md | 21 +++++++++++++++++++++ 2 files changed, 28 insertions(+) diff --git a/agent/APPEND_SYSTEM.md b/agent/APPEND_SYSTEM.md index 48f4e21..66782a1 100644 --- a/agent/APPEND_SYSTEM.md +++ b/agent/APPEND_SYSTEM.md @@ -69,6 +69,13 @@ Documentation exists for ONE reason: **point of use**. A page earns its bytes on 4. Always update the documentation when you've completed a task — and when updating means deleting a page or a paragraph, delete it. 5. Compact the work log when necessary; a work log holds laws and incidents, never bookkeeping. +#### 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. +- 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. + #### USE PROGRESSIVE DISCLOSURE. Always ensure that all produced documentation is laid out in files following WIKI conventions: start with a top level README.md index file that provides a brief, concise introduction to the item being documented, and then SPLIT OFF individual aspects, features, or arguments into their own interlinked pages so that future agents can read the documentation in a piecewise fashion, only taking in the details they need. Where relevant, crosslink any created documentation with other relevant documentation. This structure may also be nested, if necessary. diff --git a/omp-docs/log.md b/omp-docs/log.md index 207ad8b..0223a9e 100644 --- a/omp-docs/log.md +++ b/omp-docs/log.md @@ -16,6 +16,27 @@ lesson, a few lines. Full incident narratives are recoverable from git (`git log --follow omp-docs/log.md`); knowledge that outlives an entry lives on its concept page, linked here. Never re-expand an entry in place. +This page is the bundle's **only** work log: one file, at the root. Never start a +second one in a subdirectory or under another name — `scripts/kb-lint.sh` reports any +`log.md` that is not this one. + +## 2026-10-20 — one work log per bundle + +The bundle had two: this page and `core/log.md`, created "for tracking core +directory modifications" — two entries of pure migration bookkeeping (file moved, +directory created, log created), and a date for the OKF conversion that neither this +page nor git agrees with: 2026-07-15 there, 2026-01-15 here, while `git log` dates the +OKF rebuild 2026-08-28. `core/index.md` was still pointing readers at it, which is how +a stale page stays alive. Trashed to `omp-docs/core/.AGENTTRASH/log.md` — its content +is recoverable from git, which is the entire argument against a second log. + +Laws, now written down in [references/okf-spec.md](references/okf-spec.md) and +[references/okf-maintenance.md](references/okf-maintenance.md), and gated: a bundle has +ONE work log, `log.md`, at its root, and `scripts/kb-lint.sh` reports any `log.md` that +is not the root's — so the sprawl that made logging useless once cannot restart +quietly. The agent-side duty is in `agent/APPEND_SYSTEM.md` § 1: log here, read here, +never start another. + ## 2026-10-20 — two instruments rescued from `$HOME` script sediment `$HOME` had accumulated 123 loose scripts at its root (archived to