@erclx/aitk 0.77.1 → 0.78.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json
CHANGED
|
@@ -32,8 +32,21 @@ Does not govern:
|
|
|
32
32
|
|
|
33
33
|
Use `## Overview`, `## Key technical decisions` with one named H3 per decision, and `## Risks / open questions`. Name each decision and give the reasoning, especially for non-obvious choices. Skip entries where the rationale is self-evident.
|
|
34
34
|
|
|
35
|
+
## Verification anchors
|
|
36
|
+
|
|
37
|
+
A decision's reasoning stays correct while the numbers it cites move. The anchor records what a measured claim was read against, so a reader can tell a number that was checked and held from one nobody has looked at since.
|
|
38
|
+
|
|
39
|
+
- Close a decision entry whose reasoning cites a measured number with a trailing sentence naming the short commit SHA and the ISO date that number was read: `Measured at <short-sha> on <YYYY-MM-DD>.`
|
|
40
|
+
- Anchor on the number alone. A decision citing none takes no anchor whatever its reasoning rests on, because a marker over a claim nobody can re-measure is one no reader can falsify.
|
|
41
|
+
- Anchor a decision when writing it or when amending its reasoning. Leave an entry written before the rule unanchored rather than dating it by blame, which is archaeology for a marker nothing reads back.
|
|
42
|
+
- Read an absent anchor as unchecked rather than as current. On an entry citing no number there is nothing to check. On one citing a number the number is due a read.
|
|
43
|
+
- Do not edit a claim in the pass that first anchors it. The anchor states what the claim was measured against, so changing both at once leaves nothing to check the anchor against.
|
|
44
|
+
- Refresh the anchor whenever the number is re-read, whether or not it moved. A confirmed number and an unread one are the same text without the date.
|
|
45
|
+
|
|
35
46
|
## Template
|
|
36
47
|
|
|
48
|
+
The anchor sentence closes a decision whose reasoning cites a measured number and is absent from one that cites none.
|
|
49
|
+
|
|
37
50
|
```markdown
|
|
38
51
|
# Architecture
|
|
39
52
|
|
|
@@ -43,7 +56,7 @@ Use `## Overview`, `## Key technical decisions` with one named H3 per decision,
|
|
|
43
56
|
|
|
44
57
|
### Decision name
|
|
45
58
|
|
|
46
|
-
Reasoning and tradeoffs.
|
|
59
|
+
Reasoning and tradeoffs, carrying the measured number the choice rested on. Measured at <short-sha> on <YYYY-MM-DD>.
|
|
47
60
|
|
|
48
61
|
## Risks / open questions
|
|
49
62
|
```
|