scriveno 2.0.5

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.
Files changed (239) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +222 -0
  3. package/agents/continuity-checker.md +85 -0
  4. package/agents/drafter.md +248 -0
  5. package/agents/plan-checker.md +209 -0
  6. package/agents/researcher.md +114 -0
  7. package/agents/translator.md +204 -0
  8. package/agents/voice-checker.md +154 -0
  9. package/bin/install.js +1620 -0
  10. package/commands/scr/add-note.md +51 -0
  11. package/commands/scr/add-unit.md +101 -0
  12. package/commands/scr/art-direction.md +225 -0
  13. package/commands/scr/autopilot-publish.md +210 -0
  14. package/commands/scr/autopilot-translate.md +237 -0
  15. package/commands/scr/autopilot.md +200 -0
  16. package/commands/scr/back-matter.md +630 -0
  17. package/commands/scr/back-translate.md +197 -0
  18. package/commands/scr/beta-reader.md +97 -0
  19. package/commands/scr/blurb.md +149 -0
  20. package/commands/scr/book-proposal.md +210 -0
  21. package/commands/scr/build-ebook.md +448 -0
  22. package/commands/scr/build-poetry-submission.md +202 -0
  23. package/commands/scr/build-print.md +598 -0
  24. package/commands/scr/build-smashwords.md +171 -0
  25. package/commands/scr/build-world.md +158 -0
  26. package/commands/scr/cast-list.md +104 -0
  27. package/commands/scr/chapter-header.md +158 -0
  28. package/commands/scr/character-arc.md +108 -0
  29. package/commands/scr/character-ref.md +160 -0
  30. package/commands/scr/character-sheet.md +143 -0
  31. package/commands/scr/character-touch.md +157 -0
  32. package/commands/scr/character-voice-sample.md +111 -0
  33. package/commands/scr/check-notes.md +50 -0
  34. package/commands/scr/cleanup.md +159 -0
  35. package/commands/scr/compare.md +112 -0
  36. package/commands/scr/complete-draft.md +49 -0
  37. package/commands/scr/continuity-check.md +129 -0
  38. package/commands/scr/copy-edit.md +118 -0
  39. package/commands/scr/cover-art.md +382 -0
  40. package/commands/scr/cultural-adaptation.md +177 -0
  41. package/commands/scr/demo.md +93 -0
  42. package/commands/scr/dialogue-audit.md +143 -0
  43. package/commands/scr/discuss.md +118 -0
  44. package/commands/scr/discussion-questions.md +129 -0
  45. package/commands/scr/do.md +68 -0
  46. package/commands/scr/draft.md +97 -0
  47. package/commands/scr/editor-review.md +466 -0
  48. package/commands/scr/export.md +942 -0
  49. package/commands/scr/fast.md +65 -0
  50. package/commands/scr/front-matter.md +696 -0
  51. package/commands/scr/health.md +113 -0
  52. package/commands/scr/help.md +121 -0
  53. package/commands/scr/history.md +92 -0
  54. package/commands/scr/illustrate-scene.md +211 -0
  55. package/commands/scr/import.md +95 -0
  56. package/commands/scr/insert-unit.md +108 -0
  57. package/commands/scr/line-edit.md +146 -0
  58. package/commands/scr/manager.md +77 -0
  59. package/commands/scr/manuscript-stats.md +139 -0
  60. package/commands/scr/map-illustration.md +213 -0
  61. package/commands/scr/map-manuscript.md +134 -0
  62. package/commands/scr/merge-units.md +136 -0
  63. package/commands/scr/multi-publish.md +344 -0
  64. package/commands/scr/new-character.md +167 -0
  65. package/commands/scr/new-revision.md +50 -0
  66. package/commands/scr/new-work.md +148 -0
  67. package/commands/scr/next.md +125 -0
  68. package/commands/scr/originality-check.md +170 -0
  69. package/commands/scr/outline.md +131 -0
  70. package/commands/scr/pacing-analysis.md +170 -0
  71. package/commands/scr/panel-layout.md +225 -0
  72. package/commands/scr/pause-work.md +88 -0
  73. package/commands/scr/plan.md +112 -0
  74. package/commands/scr/plant-seed.md +57 -0
  75. package/commands/scr/plot-graph.md +199 -0
  76. package/commands/scr/polish.md +141 -0
  77. package/commands/scr/profile-writer.md +154 -0
  78. package/commands/scr/progress.md +51 -0
  79. package/commands/scr/publish.md +455 -0
  80. package/commands/scr/query-letter.md +183 -0
  81. package/commands/scr/quick-write.md +82 -0
  82. package/commands/scr/relationship-map.md +129 -0
  83. package/commands/scr/remove-unit.md +120 -0
  84. package/commands/scr/reorder-units.md +126 -0
  85. package/commands/scr/resume-work.md +97 -0
  86. package/commands/scr/sacred/annotation-layer.md +105 -0
  87. package/commands/scr/sacred/chronology.md +121 -0
  88. package/commands/scr/sacred/concordance.md +88 -0
  89. package/commands/scr/sacred/cross-reference.md +97 -0
  90. package/commands/scr/sacred/doctrinal-check.md +129 -0
  91. package/commands/scr/sacred/genealogy.md +107 -0
  92. package/commands/scr/sacred/source-tracking.md +101 -0
  93. package/commands/scr/sacred/verse-numbering.md +103 -0
  94. package/commands/scr/sacred-numbering-format.md +103 -0
  95. package/commands/scr/save.md +109 -0
  96. package/commands/scr/scan.md +291 -0
  97. package/commands/scr/sensitivity-review.md +169 -0
  98. package/commands/scr/series-bible.md +127 -0
  99. package/commands/scr/session-report.md +80 -0
  100. package/commands/scr/settings.md +58 -0
  101. package/commands/scr/split-unit.md +123 -0
  102. package/commands/scr/spread-layout.md +187 -0
  103. package/commands/scr/storyboard.md +262 -0
  104. package/commands/scr/subject-touch.md +168 -0
  105. package/commands/scr/submit.md +50 -0
  106. package/commands/scr/subplot-map.md +147 -0
  107. package/commands/scr/sync.md +116 -0
  108. package/commands/scr/synopsis.md +137 -0
  109. package/commands/scr/theme-tracker.md +128 -0
  110. package/commands/scr/thread.md +83 -0
  111. package/commands/scr/timeline.md +141 -0
  112. package/commands/scr/track.md +564 -0
  113. package/commands/scr/translate.md +260 -0
  114. package/commands/scr/translation-glossary.md +298 -0
  115. package/commands/scr/translation-memory.md +310 -0
  116. package/commands/scr/troubleshoot.md +59 -0
  117. package/commands/scr/undo.md +106 -0
  118. package/commands/scr/validate.md +133 -0
  119. package/commands/scr/versions.md +94 -0
  120. package/commands/scr/voice-check.md +133 -0
  121. package/commands/scr/voice-test.md +68 -0
  122. package/data/CONSTRAINTS.json +1606 -0
  123. package/data/demo/.manuscript/BRIEF.md +37 -0
  124. package/data/demo/.manuscript/CHARACTERS.md +90 -0
  125. package/data/demo/.manuscript/OUTLINE.md +46 -0
  126. package/data/demo/.manuscript/PLOT-GRAPH.md +75 -0
  127. package/data/demo/.manuscript/STATE.md +44 -0
  128. package/data/demo/.manuscript/STYLE-GUIDE.md +119 -0
  129. package/data/demo/.manuscript/THEMES.md +51 -0
  130. package/data/demo/.manuscript/WORK.md +51 -0
  131. package/data/demo/.manuscript/config.json +59 -0
  132. package/data/demo/.manuscript/drafts/body/1-the-letter-DRAFT.md +51 -0
  133. package/data/demo/.manuscript/drafts/body/2-the-workshop-DRAFT.md +51 -0
  134. package/data/demo/.manuscript/drafts/body/3-the-pier-DRAFT.md +45 -0
  135. package/data/demo/.manuscript/drafts/body/4-the-clock-DRAFT.md +59 -0
  136. package/data/demo/.manuscript/plans/5-the-reunion-PLAN.md +52 -0
  137. package/data/demo/.manuscript/reviews/2-the-workshop-REVIEW.md +61 -0
  138. package/data/export-templates/scriveno-academic.latex +184 -0
  139. package/data/export-templates/scriveno-acm.latex +67 -0
  140. package/data/export-templates/scriveno-apa7.latex +83 -0
  141. package/data/export-templates/scriveno-book.typst +175 -0
  142. package/data/export-templates/scriveno-chapbook.typst +121 -0
  143. package/data/export-templates/scriveno-elsevier.latex +76 -0
  144. package/data/export-templates/scriveno-epub.css +386 -0
  145. package/data/export-templates/scriveno-fixed-layout-epub.css +76 -0
  146. package/data/export-templates/scriveno-fixed-layout.opf +23 -0
  147. package/data/export-templates/scriveno-ieee.latex +77 -0
  148. package/data/export-templates/scriveno-lncs.latex +79 -0
  149. package/data/export-templates/scriveno-picturebook.typst +113 -0
  150. package/data/export-templates/scriveno-poetry-submission-styles.md +45 -0
  151. package/data/export-templates/scriveno-poetry-submission.docx +0 -0
  152. package/data/export-templates/scriveno-smashwords-styles.md +45 -0
  153. package/data/export-templates/scriveno-smashwords.docx +0 -0
  154. package/data/export-templates/scriveno-stageplay.typst +129 -0
  155. package/data/proof/creative-context/README.md +79 -0
  156. package/data/proof/voice-dna/GUIDED-SAMPLE.md +19 -0
  157. package/data/proof/voice-dna/README.md +45 -0
  158. package/data/proof/voice-dna/STYLE-GUIDE-EXCERPT.md +43 -0
  159. package/data/proof/voice-dna/UNGUIDED-SAMPLE.md +11 -0
  160. package/data/proof/watchmaker-flow/README.md +78 -0
  161. package/docs/architecture.md +425 -0
  162. package/docs/command-reference.md +2384 -0
  163. package/docs/configuration.md +228 -0
  164. package/docs/context-protocol.md +81 -0
  165. package/docs/contributing.md +430 -0
  166. package/docs/creative-context.md +158 -0
  167. package/docs/development.md +152 -0
  168. package/docs/drafter-quality.md +127 -0
  169. package/docs/getting-started.md +198 -0
  170. package/docs/history-protocol.md +96 -0
  171. package/docs/proof-artifacts.md +56 -0
  172. package/docs/publishing.md +296 -0
  173. package/docs/release-notes.md +457 -0
  174. package/docs/runtime-support.md +77 -0
  175. package/docs/sacred-texts.md +296 -0
  176. package/docs/shipped-assets.md +129 -0
  177. package/docs/testing.md +156 -0
  178. package/docs/translation.md +343 -0
  179. package/docs/voice-dna.md +297 -0
  180. package/docs/work-types.md +339 -0
  181. package/lib/architectural-profiles.js +134 -0
  182. package/package.json +54 -0
  183. package/templates/BRIEF.md +51 -0
  184. package/templates/CHARACTERS.md +64 -0
  185. package/templates/CONTEXT.md +56 -0
  186. package/templates/OUTLINE.md +36 -0
  187. package/templates/RECORD.md +68 -0
  188. package/templates/STATE.md +50 -0
  189. package/templates/STYLE-GUIDE.md +121 -0
  190. package/templates/THEMES.md +36 -0
  191. package/templates/WORK.md +67 -0
  192. package/templates/WORLD.md +62 -0
  193. package/templates/WRITING-RULES.md +156 -0
  194. package/templates/academic/ARGUMENT-MAP.md +40 -0
  195. package/templates/academic/CONCEPTS.md +34 -0
  196. package/templates/academic/CONTEXT.md +29 -0
  197. package/templates/academic/PROPOSAL.md +37 -0
  198. package/templates/academic/QUESTIONS.md +24 -0
  199. package/templates/config.json +72 -0
  200. package/templates/pitfalls/comic.md +54 -0
  201. package/templates/pitfalls/commentary.md +62 -0
  202. package/templates/pitfalls/memoir.md +48 -0
  203. package/templates/pitfalls/novel.md +53 -0
  204. package/templates/pitfalls/poetry_collection.md +63 -0
  205. package/templates/pitfalls/research_paper.md +66 -0
  206. package/templates/pitfalls/runbook.md +64 -0
  207. package/templates/pitfalls/screenplay.md +54 -0
  208. package/templates/platforms/README.md +16 -0
  209. package/templates/platforms/apple/manifest.yaml +20 -0
  210. package/templates/platforms/bn/manifest.yaml +20 -0
  211. package/templates/platforms/d2d/manifest.yaml +20 -0
  212. package/templates/platforms/google/manifest.yaml +20 -0
  213. package/templates/platforms/ingram/manifest.yaml +44 -0
  214. package/templates/platforms/kdp/manifest.yaml +42 -0
  215. package/templates/platforms/kobo/manifest.yaml +20 -0
  216. package/templates/platforms/smashwords/manifest.yaml +26 -0
  217. package/templates/sacred/COSMOLOGY.md +88 -0
  218. package/templates/sacred/DOCTRINES.md +45 -0
  219. package/templates/sacred/FIGURES.md +69 -0
  220. package/templates/sacred/FRAMEWORK.md +98 -0
  221. package/templates/sacred/LINEAGES.md +52 -0
  222. package/templates/sacred/README.md +20 -0
  223. package/templates/sacred/THEOLOGICAL-ARC.md +69 -0
  224. package/templates/sacred/catholic/manifest.yaml +93 -0
  225. package/templates/sacred/islamic-hafs/manifest.yaml +134 -0
  226. package/templates/sacred/islamic-warsh/manifest.yaml +134 -0
  227. package/templates/sacred/jewish/manifest.yaml +56 -0
  228. package/templates/sacred/orthodox/manifest.yaml +98 -0
  229. package/templates/sacred/pali/manifest.yaml +20 -0
  230. package/templates/sacred/protestant/manifest.yaml +86 -0
  231. package/templates/sacred/sanskrit/manifest.yaml +20 -0
  232. package/templates/sacred/tewahedo/manifest.yaml +106 -0
  233. package/templates/sacred/tibetan/manifest.yaml +20 -0
  234. package/templates/technical/AUDIENCE.md +26 -0
  235. package/templates/technical/DEPENDENCIES.md +19 -0
  236. package/templates/technical/DOC-BRIEF.md +45 -0
  237. package/templates/technical/PROCEDURES.md +37 -0
  238. package/templates/technical/REFERENCES.md +36 -0
  239. package/templates/technical/SYSTEM.md +25 -0
@@ -0,0 +1,106 @@
1
+ # Sacred tradition profile -- Ethiopian Orthodox Tewahedo.
2
+ # Populated in Phase 33 (Sacred Tradition Profiles).
3
+ # DO NOT remove this file -- Phase 29's validator (Plan 03) reads the
4
+ # directory listing to populate the allowed tradition values.
5
+ tradition: tewahedo
6
+ label: "Ethiopian Orthodox Tewahedo"
7
+ status: active
8
+ book_order:
9
+ - "Genesis"
10
+ - "Exodus"
11
+ - "Leviticus"
12
+ - "Numbers"
13
+ - "Deuteronomy"
14
+ - "Joshua"
15
+ - "Judges"
16
+ - "Ruth"
17
+ - "1 Samuel"
18
+ - "2 Samuel"
19
+ - "1 Kings"
20
+ - "2 Kings"
21
+ - "1 Chronicles"
22
+ - "2 Chronicles"
23
+ - "Jubilees"
24
+ - "Enoch"
25
+ - "Ezra"
26
+ - "Nehemiah"
27
+ - "Tobit"
28
+ - "Judith"
29
+ - "Esther"
30
+ - "1 Maccabees"
31
+ - "2 Maccabees"
32
+ - "3 Maccabees"
33
+ - "Job"
34
+ - "Psalms"
35
+ - "Proverbs"
36
+ - "Ecclesiastes"
37
+ - "Song of Songs"
38
+ - "Wisdom"
39
+ - "Sirach"
40
+ - "Isaiah"
41
+ - "Jeremiah"
42
+ - "Lamentations"
43
+ - "Baruch"
44
+ - "Ezekiel"
45
+ - "Daniel"
46
+ - "Hosea"
47
+ - "Joel"
48
+ - "Amos"
49
+ - "Obadiah"
50
+ - "Jonah"
51
+ - "Micah"
52
+ - "Nahum"
53
+ - "Habakkuk"
54
+ - "Zephaniah"
55
+ - "Haggai"
56
+ - "Zechariah"
57
+ - "Malachi"
58
+ - "Matthew"
59
+ - "Mark"
60
+ - "Luke"
61
+ - "John"
62
+ - "Acts"
63
+ - "Romans"
64
+ - "1 Corinthians"
65
+ - "2 Corinthians"
66
+ - "Galatians"
67
+ - "Ephesians"
68
+ - "Philippians"
69
+ - "Colossians"
70
+ - "1 Thessalonians"
71
+ - "2 Thessalonians"
72
+ - "1 Timothy"
73
+ - "2 Timothy"
74
+ - "Titus"
75
+ - "Philemon"
76
+ - "Hebrews"
77
+ - "James"
78
+ - "1 Peter"
79
+ - "2 Peter"
80
+ - "1 John"
81
+ - "2 John"
82
+ - "3 John"
83
+ - "Jude"
84
+ - "Revelation"
85
+ - "1 Clement"
86
+ - "2 Clement"
87
+ - "Didascalia"
88
+ - "Sinodos"
89
+ - "Clement Octateuch"
90
+ - "Ethiopic Didache"
91
+ - "Josippon"
92
+ - "Kebra Nagast"
93
+ - "Dirse Lidj"
94
+ - "Abushakar"
95
+ approval_block:
96
+ label: "Patriarchal blessing"
97
+ required: true
98
+ scope: "work"
99
+ font_stack:
100
+ - "Noto Serif Ethiopic"
101
+ - serif
102
+ rtl: false
103
+ numbering:
104
+ format: "chapter:verse"
105
+ separator: ":"
106
+ script: ethiopic
@@ -0,0 +1,20 @@
1
+ # Sacred tradition profile -- Tibetan Buddhist.
2
+ # Populated in Phase 33 (Sacred Tradition Profiles).
3
+ # DO NOT remove this file -- Phase 29's validator (Plan 03) reads the
4
+ # directory listing to populate the allowed tradition values.
5
+ tradition: tibetan
6
+ label: "Tibetan Buddhist"
7
+ status: active
8
+ book_order: null
9
+ approval_block:
10
+ label: null
11
+ required: false
12
+ scope: "work"
13
+ font_stack:
14
+ - "Noto Serif Tibetan"
15
+ - serif
16
+ rtl: false
17
+ numbering:
18
+ format: "toh:folio"
19
+ separator: "."
20
+ script: tibetan
@@ -0,0 +1,26 @@
1
+ # Audience
2
+
3
+ ## Primary reader
4
+
5
+ - **Role:** {{PRIMARY_ROLE}}
6
+ - **Experience level:** {{EXPERIENCE_LEVEL}}
7
+ - **Goal:** {{PRIMARY_GOAL}}
8
+ - **What they already know:** {{KNOWN_CONTEXT}}
9
+ - **What they may misunderstand:** {{KNOWN_GAPS}}
10
+
11
+ ## Secondary readers
12
+
13
+ {{SECONDARY_READERS}}
14
+
15
+ ## Reader contract
16
+
17
+ - Explain first: {{EXPLAIN_FIRST}}
18
+ - Define carefully: {{TERMS_TO_DEFINE}}
19
+ - Avoid assuming: {{DO_NOT_ASSUME}}
20
+ - Show examples for: {{EXAMPLE_AREAS}}
21
+
22
+ ## Accessibility and clarity notes
23
+
24
+ - **Preferred reading style:** {{READING_STYLE}}
25
+ - **Localization / terminology constraints:** {{LOCALIZATION}}
26
+ - **Safety or compliance notes:** {{SAFETY_NOTES}}
@@ -0,0 +1,19 @@
1
+ # Dependencies
2
+
3
+ ## Systems and services
4
+
5
+ | Dependency | Why it matters | Version / contract | Failure mode |
6
+ |------------|----------------|--------------------|--------------|
7
+ | {{DEPENDENCY_1}} | {{WHY_1}} | {{VERSION_1}} | {{FAILURE_1}} |
8
+
9
+ ## Required permissions and tools
10
+
11
+ {{ACCESS_AND_TOOLS}}
12
+
13
+ ## Interfaces and handoffs
14
+
15
+ {{INTERFACES}}
16
+
17
+ ## Cross-team owners
18
+
19
+ {{OWNERS}}
@@ -0,0 +1,45 @@
1
+ # Documentation brief
2
+
3
+ ## Document job
4
+
5
+ - **Document family:** {{DOC_FAMILY}}
6
+ - **Primary outcome:** {{PRIMARY_OUTCOME}}
7
+ - **Target audience:** {{AUDIENCE}}
8
+ - **Assumed knowledge:** {{PREREQUISITES}}
9
+
10
+ ## Scope
11
+
12
+ **In scope:** {{IN_SCOPE}}
13
+
14
+ **Out of scope:** {{OUT_OF_SCOPE}}
15
+
16
+ ## Supported environment
17
+
18
+ - **Product / service:** {{PRODUCT}}
19
+ - **Version range:** {{VERSION_RANGE}}
20
+ - **Platform assumptions:** {{PLATFORMS}}
21
+ - **Required access:** {{ACCESS_LEVEL}}
22
+
23
+ ## Success criteria
24
+
25
+ - Reader can complete: {{TASK_SUCCESS}}
26
+ - Reader can verify: {{VERIFICATION}}
27
+ - Reviewer can confirm accuracy from: {{SOURCE_OF_TRUTH}}
28
+
29
+ ## Subject movement
30
+
31
+ - **Reader starts with:** {{READER_START}}
32
+ - **Reader should move toward:** {{READER_SHIFT}}
33
+ - **Main pressure:** {{MAIN_PRESSURE}} (ambiguity, missing prerequisite, operational risk, version drift, unsafe action, unclear owner)
34
+ - **Key interaction:** {{KEY_INTERACTION}} (step vs. failure mode, prerequisite vs. action, source of truth vs. local convention, normal path vs. recovery path)
35
+
36
+ ## Risks to avoid
37
+
38
+ - Missing prerequisite context: {{PREREQ_RISK}}
39
+ - Unsafe or destructive guidance: {{SAFETY_RISK}}
40
+ - Version drift: {{VERSION_RISK}}
41
+ - Ambiguous terminology: {{TERM_RISK}}
42
+
43
+ ## Open questions
44
+
45
+ {{OPEN_QUESTIONS}}
@@ -0,0 +1,37 @@
1
+ # Procedures
2
+
3
+ ## Procedure index
4
+
5
+ | Procedure | When to use it | Success signal | Escalate if |
6
+ |-----------|----------------|----------------|-------------|
7
+ | {{PROCEDURE_1}} | {{WHEN_1}} | {{SUCCESS_1}} | {{ESCALATE_1}} |
8
+
9
+ ## Standard procedure template
10
+
11
+ ### {{PROCEDURE_NAME}}
12
+
13
+ **Purpose:** {{PURPOSE}}
14
+ **Prerequisites:** {{PREREQS}}
15
+ **Inputs:** {{INPUTS}}
16
+ **Expected outcome:** {{OUTCOME}}
17
+
18
+ #### Steps
19
+
20
+ 1. {{STEP_1}}
21
+ 2. {{STEP_2}}
22
+ 3. {{STEP_3}}
23
+
24
+ #### Validation
25
+
26
+ {{VALIDATION}}
27
+
28
+ #### Rollback / recovery
29
+
30
+ {{RECOVERY}}
31
+
32
+ #### Subject dynamics
33
+
34
+ **Reader starts with:** {{READER_START}}
35
+ **Reader should be able to do after this:** {{READER_SHIFT}}
36
+ **Pressure or failure mode:** {{FAILURE_MODE}}
37
+ **Interaction to make clear:** {{INTERACTION_PATTERN}} (normal path vs. exception, command vs. verification, prerequisite vs. blocked step)
@@ -0,0 +1,36 @@
1
+ # References
2
+
3
+ ## Source of truth
4
+
5
+ | Source | Type | Owner | Last checked | Notes |
6
+ |--------|------|-------|--------------|-------|
7
+ | {{SOURCE_1}} | {{TYPE_1}} | {{OWNER_1}} | {{CHECKED_1}} | {{NOTES_1}} |
8
+
9
+ ## Canonical terminology
10
+
11
+ Use this table when `/scr:discuss` or `/scr:plan` resolves a term through domain grilling. Keep entries short enough to load during planning and review.
12
+
13
+ | Term | Preferred wording | Avoid | Boundary or example | Source of truth | Reason |
14
+ |------|-------------------|-------|---------------------|-----------------|--------|
15
+ | {{TERM_1}} | {{PREFERRED_1}} | {{AVOID_1}} | {{BOUNDARY_1}} | {{SOURCE_1}} | {{REASON_1}} |
16
+
17
+ ## Domain boundaries
18
+
19
+ Use this section for terms, procedures, or system behaviors that are easy to confuse.
20
+
21
+ | Boundary | This means | This does not mean | Example check |
22
+ |----------|------------|--------------------|---------------|
23
+ | {{BOUNDARY_NAME}} | {{MEANS}} | {{DOES_NOT_MEAN}} | {{EXAMPLE_CHECK}} |
24
+
25
+ ## Examples to keep current
26
+
27
+ {{EXAMPLES}}
28
+
29
+ ## Review checklist
30
+
31
+ - Command or procedure steps match current behavior: {{CHECK_BEHAVIOR}}
32
+ - Version references are explicit: {{CHECK_VERSION}}
33
+ - Audience assumptions are still valid: {{CHECK_AUDIENCE}}
34
+ - Links and paths are still correct: {{CHECK_LINKS}}
35
+ - Canonical terminology matches the terms used in drafts and plans: {{CHECK_TERMS}}
36
+ - Domain boundaries still match current behavior and recovery paths: {{CHECK_BOUNDARIES}}
@@ -0,0 +1,25 @@
1
+ # System
2
+
3
+ ## What this document covers
4
+
5
+ {{SYSTEM_SCOPE}}
6
+
7
+ ## Architecture / environment snapshot
8
+
9
+ - **Primary components:** {{COMPONENTS}}
10
+ - **Deployment model:** {{DEPLOYMENT}}
11
+ - **Environment assumptions:** {{ENVIRONMENT}}
12
+ - **Version boundaries:** {{VERSIONS}}
13
+
14
+ ## Operating context
15
+
16
+ - **Inputs:** {{INPUTS}}
17
+ - **Outputs:** {{OUTPUTS}}
18
+ - **Known constraints:** {{KNOWN_CONSTRAINTS}}
19
+ - **Failure conditions:** {{FAILURE_CONDITIONS}}
20
+
21
+ ## Boundaries
22
+
23
+ - **Upstream systems:** {{UPSTREAM}}
24
+ - **Downstream systems:** {{DOWNSTREAM}}
25
+ - **Not covered here:** {{NOT_COVERED}}