You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: ENGI_SPEC_TEMPLATEGUIDE.md
+45-3Lines changed: 45 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -92,6 +92,24 @@ It is the ledger that separates:
92
92
- intentionally modeled boundaries,
93
93
- and still-open repo/documentation lag.
94
94
95
+
## 3.1 Matrix honesty and closure language
96
+
97
+
The implementation matrix MUST be willing to describe partial closure precisely.
98
+
99
+
Preferred judgment language includes:
100
+
-`closed`
101
+
-`spec closed; source gap`
102
+
-`substantially advanced`
103
+
-`adjunct-doc lag`
104
+
-`accepted boundary`
105
+
-`low-risk follow-up`
106
+
107
+
Matrix-honesty rules:
108
+
1. A row MUST NOT be marked `closed` merely because the spec now defines the topic well if the current source still lacks the named builder, artifact, receipt, or witness surface the spec relies on.
109
+
2. If the spec is formally complete but source realization still trails, the matrix SHOULD say so explicitly rather than compressing everything into binary open/closed language.
110
+
3. If adjunct docs are ahead or behind the matrix's previous assumption, the matrix MUST be corrected to the current repo truth rather than preserving stale review language.
111
+
4. False closure is worse than explicit debt because it hides where the next realization work actually belongs.
112
+
95
113
---
96
114
97
115
# 4. Executive summary drafting rules
@@ -287,6 +305,7 @@ Appendix rules:
287
305
1. Appendices SHOULD be internally structured rather than dumped as loose notes.
288
306
2. Appendix material SHOULD be exhaustive enough to support audit and implementation.
289
307
3. Appendix claims that matter for parity SHOULD be reflected in the implementation matrix.
308
+
4. When an appendix defines a stronger normative model than the current source fully emits, the file family SHOULD include an explicit current-implementation reading or parity-delta note rather than implying hidden closure.
290
309
291
310
---
292
311
@@ -396,6 +415,27 @@ Host-truth rules:
396
415
4. Containerization MUST be described as an execution configuration, not as implied production readiness.
397
416
5. Human-readable and structured host capability documents SHOULD stay aligned with the canonical spec status when they are referenced by the spec.
398
417
418
+
## 11.7 Settlement and exact accounting closure
419
+
420
+
For settlement/accounting material, a full enriched spec MUST define:
421
+
- source-to-shares derivation inputs and scoring weights,
422
+
- contribution entries and clipping decisions,
423
+
- normalization method and tie-break policy,
424
+
- raw shares and settled shares,
425
+
- settlement participation versus positive credit,
426
+
- zero-credit or zero-point participation semantics,
427
+
- micro-unit allocation,
428
+
- journal entries and journal diff structure,
429
+
- exact accounting invariants,
430
+
- and proof linkage between source-to-shares, participation, accounting precision, settlement proof, and journal closure.
431
+
432
+
Settlement/accounting rules:
433
+
1. The spec MUST distinguish selected assets, settlement-participating assets, positively credited assets, and zero-credit participants when those sets can differ.
434
+
2. Zero-credit or zero-point participation MUST stay explicit rather than being erased from previews, participation artifacts, or journal reasoning.
435
+
3. Clipping, normalization, and tie-break behavior MUST be replayable from declared receipts or deterministic traces.
436
+
4. Debit/credit conservation and non-negative balance expectations MUST be stated as exact invariants, not vague accounting intent.
437
+
5. If current source uses a concrete label such as `zero-credit` for a broader semantic idea such as zero-point participation, the spec SHOULD state that equivalence explicitly rather than forcing the reader to infer it.
438
+
399
439
---
400
440
401
441
# 12. Drafting rules for preserving later design truth while restoring earlier explicitness
@@ -427,9 +467,11 @@ A future full enriched ENGI release is in good structural shape when all of the
427
467
9. test coverage expectations include browser e2e and operator-experience parity where canonical,
428
468
10. spec-to-source references are deliberate and parity-bearing,
429
469
11. host capability and execution-truth surfaces are explicit when relevant,
430
-
12. notes and implementation matrix agree with the main spec,
431
-
13. prior versions remain preserved,
432
-
14. accepted boundaries are explicit rather than hidden.
470
+
12. source-to-shares, zero-credit participation, journal invariants, and exact accounting closure are explicit when relevant,
471
+
13. notes and implementation matrix agree with the main spec,
472
+
14. prior versions remain preserved,
473
+
15. accepted boundaries are explicit rather than hidden,
474
+
16. the implementation matrix uses honest closure language rather than premature `closed` judgments.
433
475
434
476
This guide is the cross-version drafting standard.
435
477
Individual `_VN_` specs remain the product/system canon for their own release, but they SHOULD now be written against this guide rather than rediscovering the structure each time.
0 commit comments