Background
Developer rules (2026-09-17): an automated test document contains the test and nothing else, and an observation is a test result — never part of the test plan, except where it states an expected result. Outcomes feed the Knowledgebase, which is how an operator finds the cause of what they are seeing; they do not belong in the document that specifies the test.
Two shapes breach that across the suite:
- 55 documents carry an
## Observed effect section. The suite index's Test outcomes feed the Knowledgebase section is what instructed them to, and its intent is right — the destination was wrong.
- Documents carry prose that is not the test: rewrite histories ("Rewritten 2026-09-08, because the previous query could not pass"), figures measured in past runs, justifications for approaches since abandoned, and reasoning about defects already fixed.
import-and-staged-actions/14 alone holds several pages of it.
docs/knowledgebase/ now exists, with a template and three entries, so relocated outcomes have a destination (#397).
What needs to be done
- Remove every
## Observed effect section, writing anything of operator value into a docs/knowledgebase/ entry first.
- Remove prose that is not needed to run or judge the test — history, past measurements, superseded rationale. What stays: the header fields,
Preconditions, Determinism as a list of pinned variables, the steps with their expected results, On failure guidance, and Cleanup.
- Reword the index's Test outcomes feed the Knowledgebase section to say where an outcome goes: a Knowledgebase entry, never the document.
- Guard it, so the shape cannot come back unnoticed.
Expected tests
| Test class / document |
Test method / what it verifies |
Starts |
| RepositoryStructureTests |
NoAutomatedTestingDocumentRecordsItsOwnOutcome |
❌ |
| RepositoryStructureTests |
TheSuiteIndexSendsOutcomesToTheKnowledgebase |
❌ |
Notes
- A document's expected results stay exactly as they are: naming the exception type a step must produce is an expectation, not an observation.
- Removing a measured figure that a step currently asserts against is out of scope here — where a figure is load-bearing, it is either an expectation the step keeps or a defect for its own issue.
Definition of done
Background
Developer rules (2026-09-17): an automated test document contains the test and nothing else, and an observation is a test result — never part of the test plan, except where it states an expected result. Outcomes feed the Knowledgebase, which is how an operator finds the cause of what they are seeing; they do not belong in the document that specifies the test.
Two shapes breach that across the suite:
## Observed effectsection. The suite index's Test outcomes feed the Knowledgebase section is what instructed them to, and its intent is right — the destination was wrong.import-and-staged-actions/14alone holds several pages of it.docs/knowledgebase/now exists, with a template and three entries, so relocated outcomes have a destination (#397).What needs to be done
## Observed effectsection, writing anything of operator value into adocs/knowledgebase/entry first.Preconditions,Determinismas a list of pinned variables, the steps with their expected results,On failureguidance, andCleanup.Expected tests
Notes
Definition of done