@nusoft/nuos-build-catalogue 0.9.0 → 0.10.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.
Files changed (26) hide show
  1. package/package.json +3 -2
  2. package/templates/protocols/end-of-session.md +19 -0
  3. package/templates/protocols/persona-new.md +43 -0
  4. package/templates/protocols/start-of-session.md +19 -0
  5. package/templates/protocols/wu-new.md +52 -0
  6. package/templates/starter-kit/CLAUDE.md +73 -0
  7. package/templates/starter-kit/README.md +116 -0
  8. package/templates/starter-kit/docs/build/END-OF-SESSION.md +62 -0
  9. package/templates/starter-kit/docs/build/START-OF-SESSION.md +33 -0
  10. package/templates/starter-kit/docs/build/STATE.md +47 -0
  11. package/templates/starter-kit/docs/build/decisions/D001-template.md +38 -0
  12. package/templates/starter-kit/docs/build/decisions/_index.md +30 -0
  13. package/templates/starter-kit/docs/build/maps/01-template.md +126 -0
  14. package/templates/starter-kit/docs/build/maps/_index.md +63 -0
  15. package/templates/starter-kit/docs/build/open-questions/_index.md +26 -0
  16. package/templates/starter-kit/docs/build/personas/001-template.md +68 -0
  17. package/templates/starter-kit/docs/build/personas/_index.md +77 -0
  18. package/templates/starter-kit/docs/build/risks/_index.md +28 -0
  19. package/templates/starter-kit/docs/build/sessions/0000-00-00-template.md +47 -0
  20. package/templates/starter-kit/docs/build/sessions/_index.md +27 -0
  21. package/templates/starter-kit/docs/build/work-units/001-template.md +82 -0
  22. package/templates/starter-kit/docs/build/work-units/_index.md +34 -0
  23. package/templates/starter-kit/docs/contracts/_index.md +26 -0
  24. package/templates/starter-kit/docs/guides/_index.md +26 -0
  25. package/templates/starter-kit/docs/philosophy/_index.md +26 -0
  26. package/templates/starter-kit/methodfile.json +54 -0
@@ -0,0 +1,26 @@
1
+ # Philosophy
2
+
3
+ > The architectural commitments of {{PROJECT_NAME}}, in narrative form. Where decisions (D-NNN) are point-in-time choices, philosophy documents are *the story of why the project is shaped this way at all*. They are read by anyone integrating with the project, by investors, and by future operators trying to understand the spirit of the system.
4
+
5
+ ## When to write a philosophy document
6
+
7
+ Not on day one. Philosophy emerges as decisions accumulate. By around D010 — perhaps D020 — patterns are visible across decisions: a recurring concern, a consistent prioritisation, an architectural commitment that was never written down because every decision implied it.
8
+
9
+ That is when a philosophy doc becomes worth writing. One short narrative-form document per cross-cutting commitment. Examples from NuOS: *separation of personal data and AI inference*, *intent-typed boundaries*, *PII isolation*.
10
+
11
+ ## Index
12
+
13
+ | Doc | Topic |
14
+ | --- | --- |
15
+ | _none yet — philosophy emerges as decisions accumulate_ | |
16
+
17
+ ## Pattern
18
+
19
+ Each philosophy doc:
20
+ - Names the commitment in present tense
21
+ - Gives the historical context — what was wrong with the alternatives
22
+ - States the architectural implications
23
+ - Lists the decisions that implement it
24
+ - Lists the contracts and surfaces it constrains
25
+
26
+ Philosophy docs are the *upstream* of decisions. A new decision should be checkable against the philosophy: is this consistent with the project's commitments? If not, either the decision is wrong or the philosophy needs revisiting.
@@ -0,0 +1,54 @@
1
+ {
2
+ "$schema": "https://nusoft.dev/schemas/methodfile/v1.json",
3
+ "method": {
4
+ "version": "1.0",
5
+ "lastValidatedAt": "{{TODAY}}"
6
+ },
7
+ "project": {
8
+ "name": "{{PROJECT_NAME}}",
9
+ "tagline": "{{PROJECT_TAGLINE}}",
10
+ "domain": "{{PROJECT_DOMAIN}}"
11
+ },
12
+ "catalogue": {
13
+ "root": "docs/build/",
14
+ "registers": {
15
+ "decisions": "decisions/",
16
+ "workUnits": "work-units/",
17
+ "sessions": "sessions/",
18
+ "risks": "risks/",
19
+ "openQuestions": "open-questions/"
20
+ },
21
+ "snapshot": "STATE.md",
22
+ "protocols": {
23
+ "startOfSession": "START-OF-SESSION.md",
24
+ "endOfSession": "END-OF-SESSION.md"
25
+ },
26
+ "supportingLayers": {
27
+ "philosophy": "../philosophy/",
28
+ "contracts": "../contracts/",
29
+ "guides": "../guides/"
30
+ }
31
+ },
32
+ "harness": {
33
+ "wired": false,
34
+ "runtime": {
35
+ "nuvector": null,
36
+ "nuflow": null,
37
+ "nuwiki": null
38
+ },
39
+ "packs": {
40
+ "method": null
41
+ },
42
+ "documentTypes": []
43
+ },
44
+ "domain": {
45
+ "type": "standard",
46
+ "confidentialityRequired": false,
47
+ "auditRetentionMonths": 0
48
+ },
49
+ "ecology": {
50
+ "role": "{{PROJECT_ROLE}}",
51
+ "parentCatalogue": null,
52
+ "siblingCatalogues": []
53
+ }
54
+ }