bmad-plus 0.13.0 → 0.14.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/CHANGELOG.md +22 -0
- package/README.md +96 -489
- package/package.json +7 -2
- package/readme-international/README.de.md +9 -5
- package/readme-international/README.es.md +9 -5
- package/readme-international/README.fr.md +9 -5
- package/src/bmad-plus/agents/agent-orchestrator/SKILL.md +3 -3
- package/src/bmad-plus/packs/pack-dev-studio/README.md +133 -141
- package/src/bmad-plus/packs/pack-dev-studio/SKILL.md +49 -0
- package/src/bmad-plus/packs/pack-dev-studio/categories/analysis/analyst-agent.md +35 -60
- package/src/bmad-plus/packs/pack-dev-studio/categories/analysis/document-project.md +59 -59
- package/src/bmad-plus/packs/pack-dev-studio/categories/analysis/domain-research.md +55 -93
- package/src/bmad-plus/packs/pack-dev-studio/categories/analysis/market-research.md +58 -93
- package/src/bmad-plus/packs/pack-dev-studio/categories/analysis/prfaq.md +55 -132
- package/src/bmad-plus/packs/pack-dev-studio/categories/analysis/product-brief.md +63 -78
- package/src/bmad-plus/packs/pack-dev-studio/categories/analysis/tech-writer-agent.md +54 -69
- package/src/bmad-plus/packs/pack-dev-studio/categories/analysis/technical-research.md +54 -93
- package/src/bmad-plus/packs/pack-dev-studio/categories/architecture/architect-agent.md +32 -60
- package/src/bmad-plus/packs/pack-dev-studio/categories/architecture/create-architecture.md +67 -71
- package/src/bmad-plus/packs/pack-dev-studio/categories/architecture/create-epics-stories.md +61 -90
- package/src/bmad-plus/packs/pack-dev-studio/categories/architecture/generate-project-context.md +56 -78
- package/src/bmad-plus/packs/pack-dev-studio/categories/architecture/implementation-readiness.md +55 -88
- package/src/bmad-plus/packs/pack-dev-studio/categories/architecture/steps/step-01-init.md +20 -153
- package/src/bmad-plus/packs/pack-dev-studio/categories/architecture/steps/step-01b-continue.md +20 -173
- package/src/bmad-plus/packs/pack-dev-studio/categories/architecture/steps/step-02-context.md +14 -220
- package/src/bmad-plus/packs/pack-dev-studio/categories/architecture/steps/step-03-starter.md +20 -329
- package/src/bmad-plus/packs/pack-dev-studio/categories/architecture/steps/step-04-decisions.md +15 -314
- package/src/bmad-plus/packs/pack-dev-studio/categories/architecture/steps/step-05-patterns.md +15 -355
- package/src/bmad-plus/packs/pack-dev-studio/categories/architecture/steps/step-06-structure.md +15 -375
- package/src/bmad-plus/packs/pack-dev-studio/categories/architecture/steps/step-07-validation.md +14 -357
- package/src/bmad-plus/packs/pack-dev-studio/categories/architecture/steps/step-08-complete.md +13 -78
- package/src/bmad-plus/packs/pack-dev-studio/categories/implementation/checkpoint-preview.md +52 -65
- package/src/bmad-plus/packs/pack-dev-studio/categories/implementation/code-review-steps/step-01-gather-context.md +14 -81
- package/src/bmad-plus/packs/pack-dev-studio/categories/implementation/code-review-steps/step-02-review.md +14 -31
- package/src/bmad-plus/packs/pack-dev-studio/categories/implementation/code-review-steps/step-03-triage.md +14 -45
- package/src/bmad-plus/packs/pack-dev-studio/categories/implementation/code-review-steps/step-04-present.md +13 -128
- package/src/bmad-plus/packs/pack-dev-studio/categories/implementation/code-review.md +61 -87
- package/src/bmad-plus/packs/pack-dev-studio/categories/implementation/correct-course.md +55 -298
- package/src/bmad-plus/packs/pack-dev-studio/categories/implementation/create-story.md +52 -426
- package/src/bmad-plus/packs/pack-dev-studio/categories/implementation/dev-agent.md +48 -69
- package/src/bmad-plus/packs/pack-dev-studio/categories/implementation/dev-story-checklist.md +22 -80
- package/src/bmad-plus/packs/pack-dev-studio/categories/implementation/dev-story.md +60 -482
- package/src/bmad-plus/packs/pack-dev-studio/categories/implementation/investigate.md +50 -184
- package/src/bmad-plus/packs/pack-dev-studio/categories/implementation/qa-e2e-tests.md +57 -173
- package/src/bmad-plus/packs/pack-dev-studio/categories/implementation/quick-dev.md +56 -108
- package/src/bmad-plus/packs/pack-dev-studio/categories/implementation/retrospective.md +54 -1509
- package/src/bmad-plus/packs/pack-dev-studio/categories/implementation/sprint-planning.md +54 -296
- package/src/bmad-plus/packs/pack-dev-studio/categories/implementation/sprint-status.md +41 -283
- package/src/bmad-plus/packs/pack-dev-studio/categories/planning/create-prd.md +58 -18
- package/src/bmad-plus/packs/pack-dev-studio/categories/planning/create-ux-design.md +103 -72
- package/src/bmad-plus/packs/pack-dev-studio/categories/planning/edit-prd.md +55 -27
- package/src/bmad-plus/packs/pack-dev-studio/categories/planning/pm-agent.md +34 -60
- package/src/bmad-plus/packs/pack-dev-studio/categories/planning/prd.md +46 -87
- package/src/bmad-plus/packs/pack-dev-studio/categories/planning/steps/step-01-init.md +10 -0
- package/src/bmad-plus/packs/pack-dev-studio/categories/planning/ux-designer-agent.md +30 -60
- package/src/bmad-plus/packs/pack-dev-studio/categories/planning/validate-prd.md +57 -27
- package/src/bmad-plus/packs/pack-dev-studio/categories/utilities/advanced-elicitation.md +47 -138
- package/src/bmad-plus/packs/pack-dev-studio/categories/utilities/adversarial-review.md +48 -34
- package/src/bmad-plus/packs/pack-dev-studio/categories/utilities/bmad-help.md +51 -68
- package/src/bmad-plus/packs/pack-dev-studio/categories/utilities/brainstorming.md +46 -3
- package/src/bmad-plus/packs/pack-dev-studio/categories/utilities/customize.md +68 -109
- package/src/bmad-plus/packs/pack-dev-studio/categories/utilities/distillator.md +53 -174
- package/src/bmad-plus/packs/pack-dev-studio/categories/utilities/edge-case-hunter.md +39 -53
- package/src/bmad-plus/packs/pack-dev-studio/categories/utilities/editorial-review-prose.md +45 -83
- package/src/bmad-plus/packs/pack-dev-studio/categories/utilities/editorial-review-structure.md +45 -176
- package/src/bmad-plus/packs/pack-dev-studio/categories/utilities/index-docs.md +45 -63
- package/src/bmad-plus/packs/pack-dev-studio/categories/utilities/party-mode.md +53 -124
- package/src/bmad-plus/packs/pack-dev-studio/categories/utilities/shard-doc.md +44 -100
- package/src/bmad-plus/packs/pack-dev-studio/dev-studio-orchestrator.md +56 -116
- package/src/bmad-plus/packs/pack-dev-studio/shared/architecture-decision-template.md +49 -12
- package/src/bmad-plus/packs/pack-dev-studio/shared/bwml-spec.md +51 -328
- package/src/bmad-plus/packs/pack-dev-studio/shared/catalog.json +489 -0
- package/src/bmad-plus/packs/pack-dev-studio/shared/execution.md +69 -0
- package/src/bmad-plus/packs/pack-dev-studio/shared/module-help.csv +39 -32
- package/src/bmad-plus/packs/pack-dev-studio/upstream-sync.yaml +85 -14
- package/src/bmad-plus/packs/pack-memory/README.md +6 -0
- package/src/bmad-plus/packs/pack-memory/memory-orchestrator.md +12 -5
- package/src/bmad-plus/packs/pack-seo/SKILL.md +27 -1
- package/src/bmad-plus/packs/pack-seo/seo-chief.md +16 -1
- package/src/bmad-plus/packs/pack-seo/seo-judge.md +12 -0
- package/src/bmad-plus/packs/pack-seo/seo-scout.md +12 -0
- package/src/bmad-plus/skills/bmad-plus-autopilot/SKILL.md +3 -3
- package/src/bmad-plus/skills/bmad-plus-sync/SKILL.md +5 -3
- package/src/bmad-plus/skills/dev-studio/SKILL.md +19 -0
- package/tools/build/check-install-contract.js +165 -13
- package/tools/build/generate.js +213 -40
- package/tools/build/generated-adapters/.codex/AGENTS.md +1 -1
- package/tools/build/generated-adapters/.cursor/rules/bmad-plus.mdc +1 -1
- package/tools/build/generated-adapters/.opencode/AGENTS.md +1 -1
- package/tools/build/generated-adapters/AGENTS.md +1 -1
- package/tools/build/generated-adapters/CLAUDE.md +1 -1
- package/tools/build/generated-adapters/CONVENTIONS.md +1 -1
- package/tools/build/generated-adapters/GEMINI.md +1 -1
- package/tools/build/pack-delivery.js +78 -0
- package/tools/cli/bmad-plus-cli.js +1 -1
- package/tools/cli/commands/doctor.js +49 -189
- package/tools/cli/commands/install.js +1 -1
- package/tools/cli/commands/studio.js +68 -0
- package/tools/cli/lib/installation-health.js +360 -0
- package/tools/cli/lib/packs.js +118 -9
- package/tools/cli/lib/python-health.js +233 -0
- package/tools/cli/lib/python-provision.js +2 -2
- package/tools/cli/lib/studio.js +310 -0
- package/tools/release/publication-content.js +901 -0
package/src/bmad-plus/packs/pack-dev-studio/categories/architecture/generate-project-context.md
CHANGED
|
@@ -1,81 +1,59 @@
|
|
|
1
|
-
|
|
1
|
+
---
|
|
2
2
|
name: bmad-generate-project-context
|
|
3
|
-
description:
|
|
3
|
+
description: Capture concise project conventions and constraints from inspected sources.
|
|
4
4
|
---
|
|
5
5
|
|
|
6
|
-
# Generate
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
### Step 5: Greet the User
|
|
61
|
-
|
|
62
|
-
Greet `{user_name}`, speaking in `{communication_language}`.
|
|
63
|
-
|
|
64
|
-
### Step 6: Execute Append Steps
|
|
65
|
-
|
|
66
|
-
Execute each entry in `{workflow.activation_steps_append}` in order.
|
|
67
|
-
|
|
68
|
-
Activation is complete. Begin the workflow below.
|
|
69
|
-
|
|
70
|
-
## Paths
|
|
71
|
-
|
|
72
|
-
- `output_file` = `{output_folder}/project-context.md`
|
|
73
|
-
|
|
74
|
-
## Execution
|
|
75
|
-
|
|
76
|
-
- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
|
|
77
|
-
- ✅ YOU MUST ALWAYS WRITE all artifact and document content in `{document_output_language}`
|
|
78
|
-
|
|
79
|
-
Load and execute `./steps/step-01-discover.md` to begin the workflow.
|
|
80
|
-
|
|
81
|
-
**Note:** Input document discovery and initialization protocols are handled in step-01-discover.md.
|
|
6
|
+
# Generate project context
|
|
7
|
+
|
|
8
|
+
Read the [execution guide](../../shared/execution.md) and
|
|
9
|
+
[Bezalel's role](architect-agent.md).
|
|
10
|
+
|
|
11
|
+
## Inputs
|
|
12
|
+
|
|
13
|
+
A request naming what project or area to summarize, or an explicit project
|
|
14
|
+
artifact. Inspect the selected directory with host tools; a prepared context
|
|
15
|
+
bundle is not a repository inspection. Read current instructions and existing
|
|
16
|
+
context before generating another file.
|
|
17
|
+
|
|
18
|
+
## Procedure
|
|
19
|
+
|
|
20
|
+
1. Identify the repository boundary and relevant source areas. Read project
|
|
21
|
+
instructions, manifests, build or test entry points and representative code.
|
|
22
|
+
Record the inspected revision or input hashes and any inaccessible areas.
|
|
23
|
+
2. Extract facts that affect future work: runtime and package manager, directory
|
|
24
|
+
responsibilities, established extension patterns, actual verification commands
|
|
25
|
+
and deployment boundaries. Cite each consequential fact to its source.
|
|
26
|
+
3. Capture invariants and recurring conventions using concrete examples. Separate
|
|
27
|
+
project requirements from an observed local pattern and from a recommendation.
|
|
28
|
+
Do not promote one unusual file into a universal rule.
|
|
29
|
+
4. Check existing context and documentation for duplication or contradictions.
|
|
30
|
+
Resolve claims by inspecting the authoritative source; keep unresolved
|
|
31
|
+
disagreements visible. Summarize useful rules rather than copying large files
|
|
32
|
+
or storing sensitive values.
|
|
33
|
+
5. Organize a compact context document around the decisions a future implementer
|
|
34
|
+
must make. Include where to look next and what has not been inspected. Label
|
|
35
|
+
commands as discovered or executed, with actual results only for executed
|
|
36
|
+
checks.
|
|
37
|
+
6. Review each statement for evidence and ongoing relevance. Write the report,
|
|
38
|
+
or the user's requested project-context destination. Never overwrite generated
|
|
39
|
+
AGENTS.md or tool adapters; changes to their rules belong in their source
|
|
40
|
+
configuration and generation workflow.
|
|
41
|
+
|
|
42
|
+
## Output and acceptance
|
|
43
|
+
|
|
44
|
+
The report for generate-project-context contains scope and freshness, source
|
|
45
|
+
ledger, project map, working conventions, acceptance/verification commands,
|
|
46
|
+
invariants and unresolved questions. State the inspected area prominently when
|
|
47
|
+
coverage is partial.
|
|
48
|
+
|
|
49
|
+
A future assistant should be able to find the implementation area and the
|
|
50
|
+
appropriate checks from this document. Unsupported prescriptions, duplicated
|
|
51
|
+
manuals and hidden assumptions should be removed or labeled as proposals.
|
|
52
|
+
The context is reference material and does not override project or user instructions.
|
|
53
|
+
|
|
54
|
+
## Continue
|
|
55
|
+
|
|
56
|
+
Read and preserve the existing document's human additions. Compare referenced
|
|
57
|
+
sources and hashes, refresh affected facts and remove stale statements only with
|
|
58
|
+
their replacement evidence recorded. An unchanged report date is not proof that
|
|
59
|
+
the project stayed unchanged.
|
package/src/bmad-plus/packs/pack-dev-studio/categories/architecture/implementation-readiness.md
CHANGED
|
@@ -1,91 +1,58 @@
|
|
|
1
|
-
|
|
1
|
+
---
|
|
2
2
|
name: bmad-check-implementation-readiness
|
|
3
|
-
description:
|
|
3
|
+
description: Check whether a selected scope has enough consistent evidence to begin implementation.
|
|
4
4
|
---
|
|
5
5
|
|
|
6
|
-
# Implementation
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
Any missing file is skipped. Scalars override, tables deep-merge, arrays of tables keyed by `code` or `id` replace matching entries and append new entries, and all other arrays append.
|
|
61
|
-
|
|
62
|
-
### Step 2: Execute Prepend Steps
|
|
63
|
-
|
|
64
|
-
Execute each entry in `{workflow.activation_steps_prepend}` in order before proceeding.
|
|
65
|
-
|
|
66
|
-
### Step 3: Load Persistent Facts
|
|
67
|
-
|
|
68
|
-
Treat every entry in `{workflow.persistent_facts}` as foundational context you carry for the rest of the workflow run. Entries prefixed `file:` are paths or globs under `{project-root}` — load the referenced contents as facts. All other entries are facts verbatim.
|
|
69
|
-
|
|
70
|
-
### Step 4: Load Config
|
|
71
|
-
|
|
72
|
-
Load config from `{project-root}/project config` and resolve:
|
|
73
|
-
- Use `{user_name}` for greeting
|
|
74
|
-
- Use `{communication_language}` for all communications
|
|
75
|
-
- Use `{document_output_language}` for output documents
|
|
76
|
-
- Use `{planning_artifacts}` for output location and artifact scanning
|
|
77
|
-
- Use `{project_knowledge}` for additional context scanning
|
|
78
|
-
|
|
79
|
-
### Step 5: Greet the User
|
|
80
|
-
|
|
81
|
-
Greet `{user_name}`, speaking in `{communication_language}`.
|
|
82
|
-
|
|
83
|
-
### Step 6: Execute Append Steps
|
|
84
|
-
|
|
85
|
-
Execute each entry in `{workflow.activation_steps_append}` in order.
|
|
86
|
-
|
|
87
|
-
Activation is complete. Begin the workflow below.
|
|
88
|
-
|
|
89
|
-
## Execution
|
|
90
|
-
|
|
91
|
-
Read fully and follow: `./steps/step-01-document-discovery.md` to begin the workflow.
|
|
6
|
+
# Implementation readiness
|
|
7
|
+
|
|
8
|
+
Read the [execution guide](../../shared/execution.md) and
|
|
9
|
+
[Bezalel's role](architect-agent.md).
|
|
10
|
+
|
|
11
|
+
## Inputs
|
|
12
|
+
|
|
13
|
+
At least one explicit planning or story artifact and the scope to assess. Use
|
|
14
|
+
supplied requirements, architecture, UX, backlog and project constraints as
|
|
15
|
+
applicable. A small maintenance task need not acquire unrelated planning documents.
|
|
16
|
+
|
|
17
|
+
## Procedure
|
|
18
|
+
|
|
19
|
+
1. Name the slice being assessed and inventory the artifacts actually read.
|
|
20
|
+
Record versions or hashes and whether each artifact describes the current
|
|
21
|
+
project. Separate absent documents from missing information.
|
|
22
|
+
2. Extract the slice's intended behavior, acceptance criteria and invariants.
|
|
23
|
+
Check that essential terms, boundaries and failure behavior have a consistent
|
|
24
|
+
meaning across inputs. Cite conflicting passages precisely.
|
|
25
|
+
3. Trace requirements through relevant UX or interface contracts, architecture
|
|
26
|
+
decisions and implementation tasks. Identify missing handoffs, contradictory
|
|
27
|
+
interfaces, uncovered constraints and acceptance checks with no observable
|
|
28
|
+
result.
|
|
29
|
+
4. Inspect readiness dependencies: repository and runtime access, required data,
|
|
30
|
+
decision owners, migrations, credentials supplied through approved channels,
|
|
31
|
+
and test capabilities. Do not request or reproduce secret values in the report.
|
|
32
|
+
A promise that access exists is not a successful access check.
|
|
33
|
+
5. Rank issues by their effect on the next implementation slice. Separate
|
|
34
|
+
prerequisites that stop it, decisions safely deferred, and improvements that
|
|
35
|
+
do not affect its acceptance. Give each blocking issue a source, consequence
|
|
36
|
+
and the smallest resolution action.
|
|
37
|
+
6. Produce a disposition of ready, needs-resolution, or insufficient-evidence.
|
|
38
|
+
Ready requires the scoped prerequisites and acceptance path to be evidenced.
|
|
39
|
+
Missing information prevents a readiness claim for the affected scope;
|
|
40
|
+
unrelated missing documents do not block useful independent work.
|
|
41
|
+
|
|
42
|
+
## Output and acceptance
|
|
43
|
+
|
|
44
|
+
Write the report for implementation-readiness with assessed scope, input ledger,
|
|
45
|
+
traceability table, issues, disposition and next actions. Use one row per relevant
|
|
46
|
+
requirement or invariant with columns for source, implementing story or task,
|
|
47
|
+
acceptance check and evidence status.
|
|
48
|
+
|
|
49
|
+
Every blocking conclusion must cite a concrete contradiction or missing
|
|
50
|
+
prerequisite. Zero issues is valid after completing the scoped assessment.
|
|
51
|
+
Readiness means work can begin under the recorded assumptions; it does not mean
|
|
52
|
+
the implementation is correct or that tests have passed.
|
|
53
|
+
|
|
54
|
+
## Continue
|
|
55
|
+
|
|
56
|
+
On new evidence, compare inputs and reassess only affected rows and dependencies.
|
|
57
|
+
Keep prior issues and record their resolution evidence. A document revision or
|
|
58
|
+
someone saying an issue is fixed is not itself proof of the relevant change.
|
|
@@ -1,153 +1,20 @@
|
|
|
1
|
-
#
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
## CONTEXT BOUNDARIES:
|
|
23
|
-
|
|
24
|
-
- Variables from workflow.md are available in memory
|
|
25
|
-
- Previous context = what's in output document + frontmatter
|
|
26
|
-
- Don't assume knowledge from other steps
|
|
27
|
-
- Input document discovery happens in this step
|
|
28
|
-
|
|
29
|
-
## YOUR TASK:
|
|
30
|
-
|
|
31
|
-
Initialize the Architecture workflow by detecting continuation state, discovering input documents, and setting up the document for collaborative architectural decision making.
|
|
32
|
-
|
|
33
|
-
## INITIALIZATION SEQUENCE:
|
|
34
|
-
|
|
35
|
-
### 1. Check for Existing Workflow
|
|
36
|
-
|
|
37
|
-
First, check if the output document already exists:
|
|
38
|
-
|
|
39
|
-
- Look for existing {planning_artifacts}/`*architecture*.md`
|
|
40
|
-
- If exists, read the complete file(s) including frontmatter
|
|
41
|
-
- If not exists, this is a fresh workflow
|
|
42
|
-
|
|
43
|
-
### 2. Handle Continuation (If Document Exists)
|
|
44
|
-
|
|
45
|
-
If the document exists and has frontmatter with `stepsCompleted`:
|
|
46
|
-
|
|
47
|
-
- **STOP here** and load `./step-01b-continue.md` immediately
|
|
48
|
-
- Do not proceed with any initialization tasks
|
|
49
|
-
- Let step-01b handle the continuation logic
|
|
50
|
-
|
|
51
|
-
### 3. Fresh Workflow Setup (If No Document)
|
|
52
|
-
|
|
53
|
-
If no document exists or no `stepsCompleted` in frontmatter:
|
|
54
|
-
|
|
55
|
-
#### A. Input Document Discovery
|
|
56
|
-
|
|
57
|
-
Discover and load context documents using smart discovery. Documents can be in the following locations:
|
|
58
|
-
- {planning_artifacts}/**
|
|
59
|
-
- {output_folder}/**
|
|
60
|
-
- {project_knowledge}/**
|
|
61
|
-
- {project-root}/docs/**
|
|
62
|
-
|
|
63
|
-
Also - when searching - documents can be a single markdown file, or a folder with an index and multiple files. For Example, if searching for `*foo*.md` and not found, also search for a folder called *foo*/index.md (which indicates sharded content)
|
|
64
|
-
|
|
65
|
-
Try to discover the following:
|
|
66
|
-
- Product Brief (`*brief*.md`)
|
|
67
|
-
- Product Requirements Document (`*prd*.md`)
|
|
68
|
-
- UX Design (`*ux-design*.md`) and other
|
|
69
|
-
- Research Documents (`*research*.md`)
|
|
70
|
-
- Project Documentation (generally multiple documents might be found for this in the `{project_knowledge}` or `{project-root}/docs` folder.)
|
|
71
|
-
- Project Context (`**/project-context.md`)
|
|
72
|
-
|
|
73
|
-
<critical>Confirm what you have found with the user, along with asking if the user wants to provide anything else. Only after this confirmation will you proceed to follow the loading rules</critical>
|
|
74
|
-
|
|
75
|
-
**Loading Rules:**
|
|
76
|
-
|
|
77
|
-
- Load ALL discovered files completely that the user confirmed or provided (no offset/limit)
|
|
78
|
-
- If there is a project context, whatever is relevant should try to be biased in the remainder of this whole workflow process
|
|
79
|
-
- For sharded folders, load ALL files to get complete picture, using the index first to potentially know the potential of each document
|
|
80
|
-
- index.md is a guide to what's relevant whenever available
|
|
81
|
-
- Track all successfully loaded files in frontmatter `inputDocuments` array
|
|
82
|
-
|
|
83
|
-
#### B. Validate Required Inputs
|
|
84
|
-
|
|
85
|
-
Before proceeding, verify we have the essential inputs:
|
|
86
|
-
|
|
87
|
-
**PRD Validation:**
|
|
88
|
-
|
|
89
|
-
- If no PRD found: "Architecture requires a PRD to work from. Please run the PRD workflow first or provide the PRD file path."
|
|
90
|
-
- Do NOT proceed without PRD
|
|
91
|
-
|
|
92
|
-
**Other Input that might exist:**
|
|
93
|
-
|
|
94
|
-
- UX Spec: "Provides UI/UX architectural requirements"
|
|
95
|
-
|
|
96
|
-
#### C. Create Initial Document
|
|
97
|
-
|
|
98
|
-
Copy the template from `../architecture-decision-template.md` to `{planning_artifacts}/architecture.md`
|
|
99
|
-
|
|
100
|
-
#### D. Complete Initialization and Report
|
|
101
|
-
|
|
102
|
-
Complete setup and report to user:
|
|
103
|
-
|
|
104
|
-
**Document Setup:**
|
|
105
|
-
|
|
106
|
-
- Created: `{planning_artifacts}/architecture.md` from template
|
|
107
|
-
- Initialized frontmatter with workflow state
|
|
108
|
-
|
|
109
|
-
**Input Documents Discovered:**
|
|
110
|
-
Report what was found:
|
|
111
|
-
"Welcome {{user_name}}! I've set up your Architecture workspace for {{project_name}}.
|
|
112
|
-
|
|
113
|
-
**Documents Found:**
|
|
114
|
-
|
|
115
|
-
- PRD: {number of PRD files loaded or "None found - REQUIRED"}
|
|
116
|
-
- UX Design: {number of UX files loaded or "None found"}
|
|
117
|
-
- Research: {number of research files loaded or "None found"}
|
|
118
|
-
- Project docs: {number of project files loaded or "None found"}
|
|
119
|
-
- Project context: {project_context_rules count of rules for AI agents found}
|
|
120
|
-
|
|
121
|
-
**Files loaded:** {list of specific file names or "No additional documents found"}
|
|
122
|
-
|
|
123
|
-
Ready to begin architectural decision making. Do you have any other documents you'd like me to include?
|
|
124
|
-
|
|
125
|
-
[C] Continue to project context analysis
|
|
126
|
-
|
|
127
|
-
## SUCCESS METRICS:
|
|
128
|
-
|
|
129
|
-
✅ Existing workflow detected and handed off to step-01b correctly
|
|
130
|
-
✅ Fresh workflow initialized with template and frontmatter
|
|
131
|
-
✅ Input documents discovered and loaded using sharded-first logic
|
|
132
|
-
✅ All discovered files tracked in frontmatter `inputDocuments`
|
|
133
|
-
✅ PRD requirement validated and communicated
|
|
134
|
-
✅ User confirmed document setup and can proceed
|
|
135
|
-
|
|
136
|
-
## FAILURE MODES:
|
|
137
|
-
|
|
138
|
-
❌ Proceeding with fresh initialization when existing workflow exists
|
|
139
|
-
❌ Not updating frontmatter with discovered input documents
|
|
140
|
-
❌ Creating document without proper template
|
|
141
|
-
❌ Not checking sharded folders first before whole files
|
|
142
|
-
❌ Not reporting what documents were found to user
|
|
143
|
-
❌ Proceeding without validating PRD requirement
|
|
144
|
-
|
|
145
|
-
❌ **CRITICAL**: Reading only partial step file - leads to incomplete understanding and poor decisions
|
|
146
|
-
❌ **CRITICAL**: Proceeding with 'C' without fully reading and understanding the next step file
|
|
147
|
-
❌ **CRITICAL**: Making decisions without complete understanding of step requirements and protocols
|
|
148
|
-
|
|
149
|
-
## NEXT STEP:
|
|
150
|
-
|
|
151
|
-
After user selects [C] to continue, only after ensuring all the template output has been created, then load `./step-02-context.md` to analyze the project context and begin architectural decision making.
|
|
152
|
-
|
|
153
|
-
Remember: Do NOT proceed to step-02 until user explicitly selects [C] from the menu and setup is confirmed!
|
|
1
|
+
# Architecture compatibility guide — establish the baseline
|
|
2
|
+
|
|
3
|
+
This retained path corresponds to procedure step 1 of
|
|
4
|
+
[create-architecture](../create-architecture.md). The main workflow is complete;
|
|
5
|
+
these guides do not form an execution chain. Follow the common
|
|
6
|
+
[execution guide](../../../shared/execution.md).
|
|
7
|
+
|
|
8
|
+
Read the actual request, project instructions and relevant prior decisions.
|
|
9
|
+
Inventory the input artifacts, their hashes when available and the current
|
|
10
|
+
implementation state. Check whether an architecture report already exists before
|
|
11
|
+
writing one, and preserve its human additions.
|
|
12
|
+
|
|
13
|
+
Record the requested outcome, system boundary, exclusions and available evidence.
|
|
14
|
+
An absent PRD does not automatically prevent a bounded architecture task; identify
|
|
15
|
+
the missing information that actually matters.
|
|
16
|
+
|
|
17
|
+
This part is complete when the baseline and intended deliverable are explicit.
|
|
18
|
+
If resuming, compare the old ledger with current inputs before trusting prior
|
|
19
|
+
decisions. Continue at the earliest incomplete part of the main procedure;
|
|
20
|
+
do not overwrite a report merely because this legacy entry was invoked.
|