@context-forge/core 0.6.5 → 0.6.6
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.
|
@@ -59,16 +59,24 @@ When creating the concept, *ask questions* if any information is missing or uncl
|
|
|
59
59
|
*Use this to design a high-level architectural component or initiative that will span multiple slices. This is the most common entry point for work on existing projects.*
|
|
60
60
|
|
|
61
61
|
```markdown
|
|
62
|
-
We're designing a new architectural component for project {project}
|
|
62
|
+
We're designing a new architectural component for project {project}. Architectural components represent major structural elements or new subsystems that will likely result in multiple slices and many tasks. This is distinct from individual slices—it's about the foundational architecture that slices will build upon.
|
|
63
63
|
|
|
64
|
-
All projects will have at least one architectural component.
|
|
64
|
+
All projects will have at least one architectural component. A small project may have only one, and will directly reference the concept document to create its architectural component. In most projects, the project manager will describe the concept being designed in the architectural component.
|
|
65
65
|
|
|
66
|
+
**Before proceeding, determine the component name and base index:**
|
|
67
|
+
1. If the project's `fileArch` is already set, use that component name and index.
|
|
68
|
+
2. If Additional Instructions below describe the component, derive the name from that description.
|
|
69
|
+
3. Otherwise, **stop and ask the Project Manager** what architectural component they want to create. Do not proceed with placeholder names.
|
|
66
70
|
|
|
67
|
-
|
|
71
|
+
**To determine the base index:**
|
|
72
|
+
- Scan `user/architecture/` for existing `nnn-arch.*.md` files to find the highest index in use.
|
|
73
|
+
- The next available index is the next multiple of 10 (e.g., if `200-arch.*.md` exists, use `210`).
|
|
74
|
+
- Valid range: 100–799 (initiative working range per `file-naming-conventions.md`).
|
|
75
|
+
- Do not use 050–099 — that is reserved for project-level architecture (HLD).
|
|
68
76
|
|
|
69
|
-
|
|
77
|
+
This base index will be shared by the slice plan and slice designs derived from this architecture document (e.g., if this document is `120-arch.name.md`, its slice plan will be `120-slices.name.md` and its first slice design will be `121-slice.first-slice.md`).
|
|
70
78
|
|
|
71
|
-
|
|
79
|
+
Create the design document for the architectural component.
|
|
72
80
|
|
|
73
81
|
Your role is Architect as described in the Process Guide. Keep this document at the architectural level—do not include task-level breakdown or detailed slice specifications.
|
|
74
82
|
|
|
@@ -83,7 +91,7 @@ docType: architecture
|
|
|
83
91
|
layer: project
|
|
84
92
|
project: {project}
|
|
85
93
|
archIndex: nnn
|
|
86
|
-
component:
|
|
94
|
+
component: component-name
|
|
87
95
|
relatedSlices: []
|
|
88
96
|
riskLevel: low|medium|high
|
|
89
97
|
dateCreated: YYYYMMDD
|
|
@@ -140,11 +148,11 @@ No direct references to individual tasks
|
|
|
140
148
|
- Be concrete about principles: Architectural principles should be clear enough to guide slice designers. Avoid vague statements.
|
|
141
149
|
|
|
142
150
|
**Expected Output**
|
|
143
|
-
* Concise architectural component design document in user/architecture/nnn-arch.
|
|
151
|
+
* Concise architectural component design document in `user/architecture/nnn-arch.component-name.md`
|
|
144
152
|
* Create if it doesn't already exist. If file exists, edit existing file as described above.
|
|
145
153
|
* Include all required YAML frontmatter
|
|
146
154
|
* Preserve any Project Manager-provided context or requirements
|
|
147
|
-
* Register the document: `cf set arch <nnn>` (e.g., `cf set arch
|
|
155
|
+
* Register the document: `cf set arch <nnn>` (e.g., `cf set arch 120`)
|
|
148
156
|
|
|
149
157
|
Follow dependency management—identify what foundation work or other architectural components this initiative depends on or affects.
|
|
150
158
|
|
package/package.json
CHANGED