@tduyng/pi-devos 0.13.6 → 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 +23 -0
- package/README.md +26 -33
- package/package.json +1 -2
- package/plugins/devos/agents/verifier.md +4 -30
- package/plugins/devos/pi/extension/devos.ts +16 -26
- package/plugins/devos/scripts/check-evidence-router.sh +7 -1
- package/plugins/devos/scripts/evidence-router.py +5 -3
- package/plugins/devos/scripts/gates/check-dod-core.sh +5 -3
- package/plugins/devos/scripts/gates/check-port-source.sh +1 -1
- package/plugins/devos/scripts/gates/check-scenario-coverage.sh +10 -8
- package/plugins/devos/scripts/gates/phase-gate.sh +6 -6
- package/plugins/devos/scripts/gates/plan-template-check.py +6 -12
- package/plugins/devos/scripts/gates/spec-contract.sh +19 -0
- package/plugins/devos/scripts/gates/spec-template-check.py +8 -21
- package/plugins/devos/scripts/gates/suite/01-dod.sh +485 -0
- package/plugins/devos/scripts/gates/suite/02-integrity.sh +310 -0
- package/plugins/devos/scripts/gates/suite/03-archetype.sh +255 -0
- package/plugins/devos/scripts/gates/suite/04-spec-validator.sh +183 -0
- package/plugins/devos/scripts/gates/suite/05-requires.sh +360 -0
- package/plugins/devos/scripts/gates/suite/06-clarify-adapters.sh +435 -0
- package/plugins/devos/scripts/gates/suite/07-lint-evals.sh +350 -0
- package/plugins/devos/scripts/gates/suite/08-converge.sh +591 -0
- package/plugins/devos/scripts/gates/suite/09-quality.sh +516 -0
- package/plugins/devos/scripts/gates/suite/10-eval-harness.sh +679 -0
- package/plugins/devos/scripts/gates/test-gates.sh +23 -4253
- package/plugins/devos/scripts/gates/test-integrity-rubric.sh +1 -1
- package/plugins/devos/scripts/gates/test-phase-gate.sh +5 -5
- package/plugins/devos/skills/build/SKILL.md +3 -3
- package/plugins/devos/skills/build/references/refactor.md +1 -1
- package/plugins/devos/skills/build/references/routes.md +4 -4
- package/plugins/devos/skills/frame/SKILL.md +22 -39
- package/plugins/devos/skills/frame/references/template.md +115 -0
- package/plugins/devos/skills/implement/SKILL.md +4 -4
- package/plugins/devos/skills/implement/references/dod.md +6 -1
- package/plugins/devos/skills/implement/references/implement.md +3 -1
- package/plugins/devos/skills/implement/references/plan.md +9 -27
- package/plugins/devos/skills/implement/references/resume.md +1 -1
- package/plugins/devos/skills/implement/references/verify-close.md +4 -3
- package/plugins/devos/skills/implement/scripts/ops-log.sh +2 -2
- package/plugins/devos/skills/implement/scripts/validate-spec.sh +17 -65
- package/plugins/devos/skills/init/references/context.md +1 -1
- package/plugins/devos/skills/review/SKILL.md +24 -47
- package/plugins/devos/skills/review/references/comments.md +13 -0
- package/plugins/devos/skills/review/references/reviewer.md +124 -0
- package/plugins/devos/skills/review/references/routing.md +35 -0
- package/plugins/devos/skills/review/scripts/__pycache__/prepare.cpython-313.pyc +0 -0
- package/plugins/devos/skills/review/scripts/prepare.py +763 -0
- package/plugins/devos/skills/spec/SKILL.md +5 -6
- package/plugins/devos/skills/spec/references/write-spec.md +36 -51
- package/plugins/devos/skills/spec/scripts/clarify.sh +4 -4
- package/plugins/devos/skills/status/SKILL.md +4 -4
- package/plugins/devos/skills/status/scripts/check-requires.py +4 -4
- package/plugins/devos/skills/status/scripts/convention-usage.sh +1 -1
- package/plugins/devos/skills/status/scripts/quality-correlation.sh +2 -25
- package/plugins/devos/scripts/gates/check-handoff.sh +0 -215
- package/plugins/devos/skills/design-taste/SKILL.md +0 -55
- package/plugins/devos/skills/design-taste/references/tells.md +0 -85
- package/plugins/devos/skills/design-taste/scripts/slop-scan.py +0 -305
- package/plugins/devos/skills/docs/SKILL.md +0 -22
- package/plugins/devos/skills/docs/references/backfill.md +0 -54
- package/plugins/devos/skills/docs/references/init.md +0 -43
- package/plugins/devos/skills/docs/references/status.md +0 -71
- package/plugins/devos/skills/docs/references/update.md +0 -80
- package/plugins/devos/skills/explain/SKILL.md +0 -45
- package/plugins/devos/skills/explain/references/quiz.md +0 -21
- package/plugins/devos/skills/frame/references/boundaries.md +0 -53
- package/plugins/devos/skills/frame/references/decompose.md +0 -96
- package/plugins/devos/skills/frame/references/impact.md +0 -43
- package/plugins/devos/skills/frame/references/interrogate.md +0 -68
- package/plugins/devos/skills/product/SKILL.md +0 -40
- package/plugins/devos/skills/product/references/planner.md +0 -54
- package/plugins/devos/skills/surgical-diff/SKILL.md +0 -23
- package/plugins/devos/skills/test-integrity/SKILL.md +0 -26
- package/plugins/devos/skills/verification-evidence/SKILL.md +0 -17
- package/plugins/devos/workflows/common/backlog-file-structure.md +0 -44
- package/plugins/devos/workflows/common/category-file-structure.md +0 -41
- package/plugins/devos/workflows/common/feature-line-format.md +0 -10
- package/plugins/devos/workflows/common/roadmap-file-structure.md +0 -51
- package/plugins/devos/workflows/common/suggest-categories.md +0 -76
- package/plugins/devos/workflows/common/suggest-milestones.md +0 -92
- package/plugins/devos/workflows/doc/doc-health.md +0 -137
- package/plugins/devos/workflows/doc/doc-writer.md +0 -44
- package/plugins/devos/workflows/doc/init-documentation.md +0 -196
- package/plugins/devos/workflows/doc/retro-documentation.md +0 -304
- package/plugins/devos/workflows/doc/templates/library.md +0 -58
- package/plugins/devos/workflows/doc/templates/service.md +0 -61
- package/plugins/devos/workflows/doc/update-documentation.md +0 -194
- package/plugins/devos/workflows/doc/write-documentation.md +0 -137
- package/plugins/devos/workflows/product/create-product-mission.md +0 -45
- package/plugins/devos/workflows/product/create-product-roadmap.md +0 -106
- package/plugins/devos/workflows/product/create-product-tech-stack.md +0 -19
- package/plugins/devos/workflows/product/gather-product-info.md +0 -25
- package/plugins/devos/workflows/product/resume-detection.md +0 -70
- package/plugins/devos/workflows/product/reverse-backlog.md +0 -118
- package/plugins/devos/workflows/product/reverse-domain-model.md +0 -86
- package/plugins/devos/workflows/product/reverse-product-plan.md +0 -81
- package/plugins/devos/workflows/product/reverse-tech-stack.md +0 -73
- package/plugins/devos/workflows/product/scan-deep.md +0 -113
- package/plugins/devos/workflows/product/scan-git.md +0 -122
- package/plugins/devos/workflows/product/scan-light.md +0 -154
|
@@ -1,137 +0,0 @@
|
|
|
1
|
-
# Workflow: Write Documentation (Agent)
|
|
2
|
-
|
|
3
|
-
**Goal:** Write or update functional documentation files within a strict scope. This workflow is paired with `doc-writer.md`.
|
|
4
|
-
|
|
5
|
-
**Input:** Scope (list of files), sources (specs, code), plan, mapping
|
|
6
|
-
|
|
7
|
-
**Output:** Written/modified documentation files, summary of changes
|
|
8
|
-
|
|
9
|
-
---
|
|
10
|
-
|
|
11
|
-
## Step 1: Read context
|
|
12
|
-
|
|
13
|
-
### 1.1 Read the sources
|
|
14
|
-
|
|
15
|
-
For each source provided by the orchestrator:
|
|
16
|
-
|
|
17
|
-
1. `Read` the source functional spec
|
|
18
|
-
2. `Read` the referenced source code files (if provided)
|
|
19
|
-
3. `Read` the documentation plan (`documentation-plan.md`)
|
|
20
|
-
4. `Read` the mapping (`documentation-mapping.md`)
|
|
21
|
-
|
|
22
|
-
### 1.2 Load templates
|
|
23
|
-
|
|
24
|
-
If `TEMPLATES_DIR` is provided:
|
|
25
|
-
1. Identify the type of file to write
|
|
26
|
-
2. `Read` the matching template
|
|
27
|
-
3. If `PROJECT_TEMPLATES_DIR` exists and contains an override → use the override
|
|
28
|
-
|
|
29
|
-
---
|
|
30
|
-
|
|
31
|
-
## Step 2: Process files (within scope)
|
|
32
|
-
|
|
33
|
-
For each file in SCOPE:
|
|
34
|
-
|
|
35
|
-
### Case A: Creation (`create`)
|
|
36
|
-
|
|
37
|
-
1. Read the matching template
|
|
38
|
-
2. Extract relevant information from the sources (specs, code)
|
|
39
|
-
3. Write the content:
|
|
40
|
-
- Follow the template structure
|
|
41
|
-
- Use domain model vocabulary if available
|
|
42
|
-
- Include Mermaid diagrams where relevant (flows, sequences, relations)
|
|
43
|
-
- **No DevOS metadata**: 100% clean markdown file
|
|
44
|
-
4. `Write` the file
|
|
45
|
-
|
|
46
|
-
### Case B: Update (`update`)
|
|
47
|
-
|
|
48
|
-
1. `Read` the existing file
|
|
49
|
-
2. Identify sections to modify
|
|
50
|
-
3. **Smart merge:**
|
|
51
|
-
- Detect manual changes (content that doesn't match the last known state)
|
|
52
|
-
- Preserve manual changes when they don't conflict
|
|
53
|
-
- On conflict: **don't write**, flag it to the orchestrator
|
|
54
|
-
4. Generate the diff of planned changes
|
|
55
|
-
5. Apply changes via `Edit`
|
|
56
|
-
|
|
57
|
-
---
|
|
58
|
-
|
|
59
|
-
## Step 3: Detecting out-of-scope changes
|
|
60
|
-
|
|
61
|
-
If, while writing, a change is needed on a file **outside the scope**:
|
|
62
|
-
|
|
63
|
-
1. **Don't modify the file**
|
|
64
|
-
2. Generate a proposed diff:
|
|
65
|
-
|
|
66
|
-
```
|
|
67
|
-
OUT_OF_SCOPE_DIFF:
|
|
68
|
-
file: path/to/out-of-scope-file.md
|
|
69
|
-
reason: [why this file needs changes]
|
|
70
|
-
diff: |
|
|
71
|
-
--- a/path/to/file.md
|
|
72
|
-
+++ b/path/to/file.md
|
|
73
|
-
@@ section @@
|
|
74
|
-
- old content
|
|
75
|
-
+ new content
|
|
76
|
-
```
|
|
77
|
-
|
|
78
|
-
The orchestrator will decide whether to apply it.
|
|
79
|
-
|
|
80
|
-
---
|
|
81
|
-
|
|
82
|
-
## Step 4: Writing rules
|
|
83
|
-
|
|
84
|
-
### Style
|
|
85
|
-
- **Language**: English (technical terms in English)
|
|
86
|
-
- **Tone**: professional, concise, factual
|
|
87
|
-
- **Structure**: prefer lists and tables over prose
|
|
88
|
-
- **Diagrams**: Mermaid for flows and relations (versionable text format)
|
|
89
|
-
|
|
90
|
-
### Content
|
|
91
|
-
- Describe the product's **current behavior** (not the spec history)
|
|
92
|
-
- Consolidate information from multiple specs into a coherent whole
|
|
93
|
-
- Resolve contradictions between specs (the most recent prevails)
|
|
94
|
-
- Include business rules, functional constraints, edge cases
|
|
95
|
-
|
|
96
|
-
### Prohibited
|
|
97
|
-
- No references to the DevOS framework
|
|
98
|
-
- No frontmatter or metadata
|
|
99
|
-
- No references to source specs (traceability lives in the mapping)
|
|
100
|
-
- No spec dates or spec versions
|
|
101
|
-
- No `TODO` or `FIXME` in the final content
|
|
102
|
-
|
|
103
|
-
---
|
|
104
|
-
|
|
105
|
-
## Step 5: Report
|
|
106
|
-
|
|
107
|
-
### Success (all files processed)
|
|
108
|
-
|
|
109
|
-
```
|
|
110
|
-
DOC_WRITER_REPORT: SUCCESS
|
|
111
|
-
files_created: [N]
|
|
112
|
-
files_updated: [N]
|
|
113
|
-
conflicts: 0
|
|
114
|
-
```
|
|
115
|
-
|
|
116
|
-
### With conflicts
|
|
117
|
-
|
|
118
|
-
```
|
|
119
|
-
DOC_WRITER_REPORT: CONFLICTS
|
|
120
|
-
files_created: [N]
|
|
121
|
-
files_updated: [N]
|
|
122
|
-
conflicts: [N]
|
|
123
|
-
conflict_details:
|
|
124
|
-
- file: path/to/file.md
|
|
125
|
-
section: [section name]
|
|
126
|
-
reason: Manual edits detected, cannot auto-merge
|
|
127
|
-
```
|
|
128
|
-
|
|
129
|
-
### With out-of-scope changes
|
|
130
|
-
|
|
131
|
-
```
|
|
132
|
-
DOC_WRITER_REPORT: OUT_OF_SCOPE
|
|
133
|
-
files_created: [N]
|
|
134
|
-
files_updated: [N]
|
|
135
|
-
out_of_scope_diffs: [N]
|
|
136
|
-
[include diffs from Step 3]
|
|
137
|
-
```
|
|
@@ -1,45 +0,0 @@
|
|
|
1
|
-
Create `devos/product/mission.md` with comprehensive product definition following this structure for its' content:
|
|
2
|
-
|
|
3
|
-
#### Mission Structure:
|
|
4
|
-
```markdown
|
|
5
|
-
# Product Mission
|
|
6
|
-
|
|
7
|
-
## Pitch
|
|
8
|
-
[PRODUCT_NAME] is a [PRODUCT_TYPE] that helps [TARGET_USERS] [SOLVE_PROBLEM]
|
|
9
|
-
by providing [KEY_VALUE_PROPOSITION].
|
|
10
|
-
|
|
11
|
-
## Users
|
|
12
|
-
|
|
13
|
-
### Primary Customers
|
|
14
|
-
- [CUSTOMER_SEGMENT_1]: [DESCRIPTION]
|
|
15
|
-
- [CUSTOMER_SEGMENT_2]: [DESCRIPTION]
|
|
16
|
-
|
|
17
|
-
## The Problem
|
|
18
|
-
|
|
19
|
-
### [PROBLEM_TITLE]
|
|
20
|
-
[PROBLEM_DESCRIPTION]. [QUANTIFIABLE_IMPACT].
|
|
21
|
-
|
|
22
|
-
**Our Solution:** [SOLUTION_APPROACH]
|
|
23
|
-
|
|
24
|
-
## Differentiators
|
|
25
|
-
|
|
26
|
-
### [DIFFERENTIATOR_TITLE]
|
|
27
|
-
Unlike [COMPETITOR/ALTERNATIVE], we provide [SPECIFIC_ADVANTAGE].
|
|
28
|
-
This results in [MEASURABLE_BENEFIT].
|
|
29
|
-
|
|
30
|
-
## Key Features
|
|
31
|
-
|
|
32
|
-
### Core Features
|
|
33
|
-
- **[FEATURE_NAME]:** [USER_BENEFIT_DESCRIPTION]
|
|
34
|
-
|
|
35
|
-
### Collaboration Features
|
|
36
|
-
- **[FEATURE_NAME]:** [USER_BENEFIT_DESCRIPTION]
|
|
37
|
-
|
|
38
|
-
### Advanced Features
|
|
39
|
-
- **[FEATURE_NAME]:** [USER_BENEFIT_DESCRIPTION]
|
|
40
|
-
```
|
|
41
|
-
|
|
42
|
-
#### Important Constraints
|
|
43
|
-
|
|
44
|
-
- **Focus on user benefits** in feature descriptions, not technical details
|
|
45
|
-
- **Keep it concise** and easy for users to scan and get the more important concepts quickly
|
|
@@ -1,106 +0,0 @@
|
|
|
1
|
-
Generate the product roadmap structure (v0.4 format) with milestones, categories, and backlog.
|
|
2
|
-
|
|
3
|
-
---
|
|
4
|
-
|
|
5
|
-
## Step 1: Read Prerequisites
|
|
6
|
-
|
|
7
|
-
1. **Read** `devos/product/mission.md` to understand goals and features
|
|
8
|
-
2. **Extract** the list of features from the "Key Features" section
|
|
9
|
-
3. **IF** mission.md doesn't exist:
|
|
10
|
-
```
|
|
11
|
-
ERROR: mission.md not found
|
|
12
|
-
|
|
13
|
-
Run /devos:product first to create the product mission.
|
|
14
|
-
```
|
|
15
|
-
**STOP** workflow.
|
|
16
|
-
|
|
17
|
-
---
|
|
18
|
-
|
|
19
|
-
## Step 2: Read Project Configuration
|
|
20
|
-
|
|
21
|
-
Generated content follows the language rules in AGENTS.md, like everything else, no per-command language logic.
|
|
22
|
-
|
|
23
|
-
---
|
|
24
|
-
|
|
25
|
-
## Step 3: Milestone names
|
|
26
|
-
|
|
27
|
-
Ask the user what to call each milestone (or propose short functional names from the milestone's content). No naming themes.
|
|
28
|
-
|
|
29
|
-
---
|
|
30
|
-
|
|
31
|
-
## Step 4: Categorization Strategy
|
|
32
|
-
|
|
33
|
-
**MANDATORY: You MUST display the question and WAIT for the user's response before proceeding.**
|
|
34
|
-
**DO NOT skip this step. DO NOT auto-generate categories without asking.**
|
|
35
|
-
|
|
36
|
-
Read and follow `${CLAUDE_PLUGIN_ROOT}/workflows/common/suggest-categories.md`.
|
|
37
|
-
|
|
38
|
-
---
|
|
39
|
-
|
|
40
|
-
## Step 5: Milestone Strategy
|
|
41
|
-
|
|
42
|
-
**MANDATORY: You MUST display the question and WAIT for the user's response before proceeding.**
|
|
43
|
-
**DO NOT skip this step. DO NOT auto-generate milestones without asking.**
|
|
44
|
-
|
|
45
|
-
Read and follow `${CLAUDE_PLUGIN_ROOT}/workflows/common/suggest-milestones.md`.
|
|
46
|
-
|
|
47
|
-
---
|
|
48
|
-
|
|
49
|
-
## Step 6: Create File Structure
|
|
50
|
-
|
|
51
|
-
### 6.1 Create backlog/ folder
|
|
52
|
-
|
|
53
|
-
```bash
|
|
54
|
-
mkdir -p devos/product/backlog
|
|
55
|
-
```
|
|
56
|
-
|
|
57
|
-
### 6.2 Create category files
|
|
58
|
-
|
|
59
|
-
**FOR EACH** category determined in Step 4:
|
|
60
|
-
|
|
61
|
-
Create `devos/product/backlog/[category-id].md`:
|
|
62
|
-
|
|
63
|
-
Read and follow `${CLAUDE_PLUGIN_ROOT}/workflows/common/category-file-structure.md`.
|
|
64
|
-
|
|
65
|
-
### 6.3 Create roadmap.md (v0.4 format)
|
|
66
|
-
|
|
67
|
-
Read and follow `${CLAUDE_PLUGIN_ROOT}/workflows/common/roadmap-file-structure.md`.
|
|
68
|
-
|
|
69
|
-
Read and follow `${CLAUDE_PLUGIN_ROOT}/workflows/common/feature-line-format.md`.
|
|
70
|
-
|
|
71
|
-
### 6.4 Create backlog.md (index)
|
|
72
|
-
|
|
73
|
-
Read and follow `${CLAUDE_PLUGIN_ROOT}/workflows/common/backlog-file-structure.md`.
|
|
74
|
-
|
|
75
|
-
---
|
|
76
|
-
|
|
77
|
-
## Step 7: Confirmation
|
|
78
|
-
|
|
79
|
-
```
|
|
80
|
-
Product roadmap created (v0.4 format)
|
|
81
|
-
|
|
82
|
-
Files created:
|
|
83
|
-
├── devos/product/roadmap.md
|
|
84
|
-
│ └── [N] milestones, [X] features planned
|
|
85
|
-
├── devos/product/backlog.md
|
|
86
|
-
│ └── Index of [Y] unplanned features
|
|
87
|
-
└── devos/product/backlog/
|
|
88
|
-
├── [category-1].md ([A] features)
|
|
89
|
-
├── [category-2].md ([B] features)
|
|
90
|
-
└── ...
|
|
91
|
-
|
|
92
|
-
Next steps:
|
|
93
|
-
- Edit roadmap.md directly to reorganize features between milestones
|
|
94
|
-
- Edit backlog.md directly to add new features
|
|
95
|
-
- Use /devos:spec to start specifying a feature
|
|
96
|
-
```
|
|
97
|
-
|
|
98
|
-
---
|
|
99
|
-
|
|
100
|
-
## Important Constraints
|
|
101
|
-
|
|
102
|
-
- **v0.4 format** - Always create YAML frontmatter + milestones structure
|
|
103
|
-
- **Category files** - YAML frontmatter only, no markdown body
|
|
104
|
-
- **Backlog.md** - Markdown only, no YAML frontmatter
|
|
105
|
-
- **Feature traceability** - Each feature appears in both category file AND roadmap/backlog
|
|
106
|
-
- **No bootstrap tasks** - Assume project codebase already exists
|
|
@@ -1,19 +0,0 @@
|
|
|
1
|
-
Create `devos/product/tech-stack.md` with a list of all tech stack choices that cover all aspects of this product's codebase.
|
|
2
|
-
|
|
3
|
-
### Creating the Tech Stack document
|
|
4
|
-
|
|
5
|
-
#### Step 1: Note User's Input Regarding Tech Stack
|
|
6
|
-
|
|
7
|
-
IF the user has provided specific information in the current conversation in regards to tech stack choices, these notes ALWAYS take precidence. These must be reflected in your final `tech-stack.md` document that you will create.
|
|
8
|
-
|
|
9
|
-
#### Step 2: Gather User's Default Tech Stack Information
|
|
10
|
-
|
|
11
|
-
Reconcile and fill in the remaining gaps in the tech stack list by finding, reading and analyzing information regarding the tech stack. Find this information in the following sources, in this order:
|
|
12
|
-
|
|
13
|
-
1. If user has provided their default tech stack under "User Standards & Preferences Compliance", READ and analyze this document.
|
|
14
|
-
2. If the current project has any of these files, read them to find information regarding tech stack choices for this codebase:
|
|
15
|
-
- `AGENTS.md`
|
|
16
|
-
|
|
17
|
-
#### Step 3: Create the Tech Stack Document
|
|
18
|
-
|
|
19
|
-
Create `devos/product/tech-stack.md` and populate it with the final list of all technical stack choices, reconciled between the information the user has provided to you and the information found in provided sources.
|
|
@@ -1,25 +0,0 @@
|
|
|
1
|
-
Collect comprehensive product information from the user:
|
|
2
|
-
|
|
3
|
-
```bash
|
|
4
|
-
# Check if product folder already exists
|
|
5
|
-
if [ -d "devos/product" ]; then
|
|
6
|
-
echo "Product documentation already exists. Review existing files or start fresh?"
|
|
7
|
-
# List existing product files
|
|
8
|
-
ls -la devos/product/
|
|
9
|
-
fi
|
|
10
|
-
```
|
|
11
|
-
|
|
12
|
-
Gather from user the following required information:
|
|
13
|
-
- **Product Idea**: Core concept and purpose (required)
|
|
14
|
-
- **Key Features**: Minimum 3 features with descriptions
|
|
15
|
-
- **Target Users**: At least 1 user segment with use cases
|
|
16
|
-
- **Tech stack**: Confirmation or info regarding the product's tech stack choices
|
|
17
|
-
|
|
18
|
-
If any required information is missing, prompt user:
|
|
19
|
-
```
|
|
20
|
-
Please provide the following to create your product plan:
|
|
21
|
-
1. Main idea for the product
|
|
22
|
-
2. List of key features (minimum 3)
|
|
23
|
-
3. Target users and use cases (minimum 1)
|
|
24
|
-
4. Will this product use your usual tech stack choices or deviate in any way?
|
|
25
|
-
```
|
|
@@ -1,70 +0,0 @@
|
|
|
1
|
-
# Workflow: Resume Detection
|
|
2
|
-
|
|
3
|
-
**Goal:** Detect onboarding progress from the presence of artifacts. No `.state.json`: detection is purely file-based.
|
|
4
|
-
|
|
5
|
-
---
|
|
6
|
-
|
|
7
|
-
## Detection
|
|
8
|
-
|
|
9
|
-
Check for artifacts in reverse order (most advanced to least advanced):
|
|
10
|
-
|
|
11
|
-
### Check Phase 4 (Documentation)
|
|
12
|
-
|
|
13
|
-
```bash
|
|
14
|
-
# Check whether documentation has real content (not just skeletons)
|
|
15
|
-
find documentation/ -name "*.md" -not -name "index.html" 2>/dev/null | head -5
|
|
16
|
-
```
|
|
17
|
-
|
|
18
|
-
If documentation files with substantial content exist:
|
|
19
|
-
|
|
20
|
-
```
|
|
21
|
-
Onboarding detected at Phase 5 (documentation complete).
|
|
22
|
-
Onboarding appears to already be complete.
|
|
23
|
-
|
|
24
|
-
Do you want to:
|
|
25
|
-
A) Restart from the beginning (warning: overwrites existing artifacts)
|
|
26
|
-
B) Jump straight to post-onboarding suggestions
|
|
27
|
-
```
|
|
28
|
-
|
|
29
|
-
**WAIT** for the response. If A → resume Phase 1. If B → go to Phase 5.
|
|
30
|
-
|
|
31
|
-
### Check Phase 3 (Reconstruction)
|
|
32
|
-
|
|
33
|
-
```bash
|
|
34
|
-
ls devos/product/mission.md devos/product/domain-model.md devos/product/tech-stack.md 2>/dev/null
|
|
35
|
-
```
|
|
36
|
-
|
|
37
|
-
If all three files exist:
|
|
38
|
-
|
|
39
|
-
```
|
|
40
|
-
Onboarding detected at Phase 3 (foundations reconstructed).
|
|
41
|
-
Resume at Phase 4 (documentation)?
|
|
42
|
-
```
|
|
43
|
-
|
|
44
|
-
If yes → go to Phase 4.
|
|
45
|
-
|
|
46
|
-
### Check Phase 2 (Deep Scan)
|
|
47
|
-
|
|
48
|
-
```bash
|
|
49
|
-
ls devos/onboarding/findings/*.md 2>/dev/null
|
|
50
|
-
```
|
|
51
|
-
|
|
52
|
-
If findings exist:
|
|
53
|
-
|
|
54
|
-
```
|
|
55
|
-
Onboarding detected at Phase 2 (deep scan complete).
|
|
56
|
-
[N] findings files found.
|
|
57
|
-
Resume at Phase 3 (reconstruction)?
|
|
58
|
-
```
|
|
59
|
-
|
|
60
|
-
If yes → go to Phase 3.
|
|
61
|
-
|
|
62
|
-
### No artifacts
|
|
63
|
-
|
|
64
|
-
If no onboarding artifacts are detected:
|
|
65
|
-
|
|
66
|
-
```
|
|
67
|
-
No previous onboarding detected. Starting from Phase 1.
|
|
68
|
-
```
|
|
69
|
-
|
|
70
|
-
→ go to Phase 1.
|
|
@@ -1,118 +0,0 @@
|
|
|
1
|
-
# Workflow: Reverse Backlog (Phase 3)
|
|
2
|
-
|
|
3
|
-
**Goal:** Classify the project's existing functionality into a backlog structured by domain. Generate `backlog.md`, the category files `backlog/*.md`, and an empty `roadmap.md`. Reverse equivalent of `/devos:product` (phase 3).
|
|
4
|
-
|
|
5
|
-
**Input:** Consolidated findings, reconstructed domain model
|
|
6
|
-
|
|
7
|
-
**Output:** `devos/product/backlog.md`, `devos/product/backlog/*.md`, `devos/product/roadmap.md`
|
|
8
|
-
|
|
9
|
-
---
|
|
10
|
-
|
|
11
|
-
## Step 1: Identify Existing Features
|
|
12
|
-
|
|
13
|
-
From the findings:
|
|
14
|
-
1. Each **service** or coherent **set of services** = a potential feature
|
|
15
|
-
2. Each **group of API endpoints** = a potential feature
|
|
16
|
-
3. Each **functional domain** with entities and business rules = a category
|
|
17
|
-
|
|
18
|
-
For each identified feature:
|
|
19
|
-
- Name (kebab-case)
|
|
20
|
-
- Description (1-2 lines)
|
|
21
|
-
- Domain/category
|
|
22
|
-
- Estimated size (XS/S/M/L/XL based on file count and complexity)
|
|
23
|
-
|
|
24
|
-
---
|
|
25
|
-
|
|
26
|
-
## Step 2: Organize by Category
|
|
27
|
-
|
|
28
|
-
Group features by functional domain (from the domain model):
|
|
29
|
-
|
|
30
|
-
| Category | Features |
|
|
31
|
-
|----------|----------|
|
|
32
|
-
| [domain-1] | feature-a, feature-b, feature-c |
|
|
33
|
-
| [domain-2] | feature-d, feature-e |
|
|
34
|
-
|
|
35
|
-
---
|
|
36
|
-
|
|
37
|
-
## Step 3: Build the Drafts
|
|
38
|
-
|
|
39
|
-
### 3.1 Category files (`backlog/[category-id].md`)
|
|
40
|
-
|
|
41
|
-
For each category:
|
|
42
|
-
|
|
43
|
-
```yaml
|
|
44
|
-
---
|
|
45
|
-
category_id: [kebab-case]
|
|
46
|
-
name: [Domain name]
|
|
47
|
-
features:
|
|
48
|
-
- feature_id: [kebab-case]
|
|
49
|
-
name: [Feature name]
|
|
50
|
-
description: |
|
|
51
|
-
[Description inferred from the code]
|
|
52
|
-
size: [XS|S|M|L|XL]
|
|
53
|
-
milestone: null
|
|
54
|
-
spec: null
|
|
55
|
-
finalized: true
|
|
56
|
-
---
|
|
57
|
-
```
|
|
58
|
-
|
|
59
|
-
All features are marked `finalized: true` (they already exist in the code).
|
|
60
|
-
|
|
61
|
-
### 3.2 Backlog index (`backlog.md`)
|
|
62
|
-
|
|
63
|
-
```markdown
|
|
64
|
-
## Category: [Domain name]
|
|
65
|
-
[category-id](backlog/category-id.md)
|
|
66
|
-
- [x] Feature A [M] - [category-id](backlog/category-id.md) - No spec yet
|
|
67
|
-
- [x] Feature B [S] - [category-id](backlog/category-id.md) - No spec yet
|
|
68
|
-
```
|
|
69
|
-
|
|
70
|
-
Finalized features are checked `[x]`.
|
|
71
|
-
|
|
72
|
-
### 3.3 Empty Roadmap (`roadmap.md`)
|
|
73
|
-
|
|
74
|
-
```yaml
|
|
75
|
-
---
|
|
76
|
-
milestones: []
|
|
77
|
-
---
|
|
78
|
-
```
|
|
79
|
-
|
|
80
|
-
```markdown
|
|
81
|
-
# Product Roadmap
|
|
82
|
-
|
|
83
|
-
_Roadmap initialized by /devos:init. Edit roadmap.md directly (or re-run /devos:product) to plan upcoming features._
|
|
84
|
-
```
|
|
85
|
-
|
|
86
|
-
If planning data was found via MCP, pre-fill with the detected milestones.
|
|
87
|
-
|
|
88
|
-
---
|
|
89
|
-
|
|
90
|
-
## Step 4: Interactive Validation
|
|
91
|
-
|
|
92
|
-
Present the draft to you:
|
|
93
|
-
|
|
94
|
-
```
|
|
95
|
-
Backlog reconstructed from the code:
|
|
96
|
-
|
|
97
|
-
Categories: [N]
|
|
98
|
-
Features: [N] (all marked finalized)
|
|
99
|
-
|
|
100
|
-
[Summary table by category]
|
|
101
|
-
|
|
102
|
-
Does this backlog look correct?
|
|
103
|
-
- Validate as-is
|
|
104
|
-
- Rename categories or features
|
|
105
|
-
- Add/remove features
|
|
106
|
-
- Change estimated sizes
|
|
107
|
-
```
|
|
108
|
-
|
|
109
|
-
**WAIT** for validation. Iterate until validated.
|
|
110
|
-
|
|
111
|
-
---
|
|
112
|
-
|
|
113
|
-
## Step 5: Write
|
|
114
|
-
|
|
115
|
-
1. `mkdir -p devos/product/backlog/`
|
|
116
|
-
2. `Write` each category file
|
|
117
|
-
3. `Write` the `backlog.md` file
|
|
118
|
-
4. `Write` the `roadmap.md` file
|
|
@@ -1,86 +0,0 @@
|
|
|
1
|
-
# Workflow: Reverse Domain Model (Phase 3)
|
|
2
|
-
|
|
3
|
-
**Goal:** Extract entities and relationships from the findings to generate `domain-model.md` in the standard DevOS format. Reverse equivalent of `/devos:init`.
|
|
4
|
-
|
|
5
|
-
**Input:** Consolidated findings (`devos/onboarding/findings/*.md`)
|
|
6
|
-
|
|
7
|
-
**Output:** `devos/product/domain-model.md`
|
|
8
|
-
|
|
9
|
-
---
|
|
10
|
-
|
|
11
|
-
## Step 1: Extract Entities
|
|
12
|
-
|
|
13
|
-
1. `Read` each findings file
|
|
14
|
-
2. Collect all identified business entities (not technical entities like Repository, Service, Controller)
|
|
15
|
-
3. For each entity:
|
|
16
|
-
- Name (normalized to singular, PascalCase)
|
|
17
|
-
- Description inferred from the code
|
|
18
|
-
- Main attributes
|
|
19
|
-
- Domain it belongs to
|
|
20
|
-
|
|
21
|
-
---
|
|
22
|
-
|
|
23
|
-
## Step 2: Extract Relationships
|
|
24
|
-
|
|
25
|
-
From the findings:
|
|
26
|
-
1. Import and reference relationships between entities
|
|
27
|
-
2. Composition/aggregation relationships (has many, belongs to)
|
|
28
|
-
3. Association relationships (links X and Y)
|
|
29
|
-
4. Deduplication (same entity found in multiple domains)
|
|
30
|
-
|
|
31
|
-
---
|
|
32
|
-
|
|
33
|
-
## Step 3: Build the Draft
|
|
34
|
-
|
|
35
|
-
```markdown
|
|
36
|
-
# Domain Model
|
|
37
|
-
|
|
38
|
-
## Entities
|
|
39
|
-
|
|
40
|
-
### [EntityName]
|
|
41
|
-
[Natural-language description of the entity and its role in the system.]
|
|
42
|
-
|
|
43
|
-
### [AnotherEntity]
|
|
44
|
-
[Natural-language description.]
|
|
45
|
-
|
|
46
|
-
## Relationships
|
|
47
|
-
|
|
48
|
-
- [Entity1] has many [Entity2]
|
|
49
|
-
- [Entity2] belongs to [Entity1]
|
|
50
|
-
- [Entity3] links [Entity1] and [Entity4]
|
|
51
|
-
```
|
|
52
|
-
|
|
53
|
-
**Rules:**
|
|
54
|
-
- Singular names: `User`, not `Users`
|
|
55
|
-
- Natural language: understandable by non-technical people
|
|
56
|
-
- Conceptual relationships, no technical details (no FKs, no DB types)
|
|
57
|
-
- No YAML frontmatter
|
|
58
|
-
|
|
59
|
-
---
|
|
60
|
-
|
|
61
|
-
## Step 4: Interactive Validation
|
|
62
|
-
|
|
63
|
-
Present the draft to you:
|
|
64
|
-
|
|
65
|
-
```
|
|
66
|
-
Domain model reconstructed from the code:
|
|
67
|
-
|
|
68
|
-
Entities: [N]
|
|
69
|
-
Relationships: [N]
|
|
70
|
-
|
|
71
|
-
[show the content]
|
|
72
|
-
|
|
73
|
-
Does this model look correct?
|
|
74
|
-
- Validate as-is
|
|
75
|
-
- Add missing entities
|
|
76
|
-
- Fix names or descriptions
|
|
77
|
-
- Start over
|
|
78
|
-
```
|
|
79
|
-
|
|
80
|
-
**WAIT** for validation. Iterate until validated.
|
|
81
|
-
|
|
82
|
-
---
|
|
83
|
-
|
|
84
|
-
## Step 5: Write
|
|
85
|
-
|
|
86
|
-
`Write` the file `devos/product/domain-model.md` with the validated content.
|
|
@@ -1,81 +0,0 @@
|
|
|
1
|
-
# Workflow: Reverse Product Plan (Phase 3)
|
|
2
|
-
|
|
3
|
-
**Goal:** Consolidate the deep-scan findings to generate `mission.md` in the standard DevOS format. Reverse equivalent of `/devos:product` (phases 1-2).
|
|
4
|
-
|
|
5
|
-
**Input:** Consolidated findings (`devos/onboarding/findings/*.md`), MCP data (optional)
|
|
6
|
-
|
|
7
|
-
**Output:** `devos/product/mission.md`
|
|
8
|
-
|
|
9
|
-
---
|
|
10
|
-
|
|
11
|
-
## Step 1: Read the Findings
|
|
12
|
-
|
|
13
|
-
1. `Glob devos/onboarding/findings/*.md`
|
|
14
|
-
2. `Read` each findings file
|
|
15
|
-
3. Extract from each findings file:
|
|
16
|
-
- Identified business entities → indicators of users and domain
|
|
17
|
-
- Services and their responsibilities → indicators of features
|
|
18
|
-
- Architectural patterns → indicators of technical choices
|
|
19
|
-
- APIs and interactions → indicators of functional scope
|
|
20
|
-
|
|
21
|
-
---
|
|
22
|
-
|
|
23
|
-
## Step 2: Reconstruct the Mission
|
|
24
|
-
|
|
25
|
-
From the consolidated findings, produce a `mission.md` draft in the standard format:
|
|
26
|
-
|
|
27
|
-
```markdown
|
|
28
|
-
# Product Mission
|
|
29
|
-
|
|
30
|
-
## Pitch
|
|
31
|
-
[Product] is a [application type] that [description of the main purpose inferred from the code].
|
|
32
|
-
|
|
33
|
-
## Users
|
|
34
|
-
|
|
35
|
-
### Primary Customers
|
|
36
|
-
[Inferred from user entities, roles, and permissions found in the code]
|
|
37
|
-
|
|
38
|
-
## The Problem
|
|
39
|
-
[Inferred from the business domain, business rules, identified services]
|
|
40
|
-
|
|
41
|
-
## Differentiators
|
|
42
|
-
[Inferred from architectural patterns, technical choices, unique features]
|
|
43
|
-
|
|
44
|
-
## Key Features
|
|
45
|
-
|
|
46
|
-
### Core Features
|
|
47
|
-
[Inferred from main services, endpoints, key features]
|
|
48
|
-
|
|
49
|
-
### Advanced Features
|
|
50
|
-
[Inferred from secondary features]
|
|
51
|
-
```
|
|
52
|
-
|
|
53
|
-
**Writing rules:**
|
|
54
|
-
- Base it on **facts observed in the code** (no invention)
|
|
55
|
-
- Use a factual tone: "The system manages..." rather than "The system could manage..."
|
|
56
|
-
- Flag uncertainties: "[To confirm]" when the analysis is ambiguous
|
|
57
|
-
|
|
58
|
-
---
|
|
59
|
-
|
|
60
|
-
## Step 3: Interactive Validation
|
|
61
|
-
|
|
62
|
-
Present the draft to you:
|
|
63
|
-
|
|
64
|
-
```
|
|
65
|
-
Product mission reconstructed from the code:
|
|
66
|
-
|
|
67
|
-
[show the draft content]
|
|
68
|
-
|
|
69
|
-
Does this reconstruction look correct?
|
|
70
|
-
- Validate as-is
|
|
71
|
-
- Modify (specify the corrections)
|
|
72
|
-
- Start over (give guidance)
|
|
73
|
-
```
|
|
74
|
-
|
|
75
|
-
**WAIT** for validation. Apply corrections if requested. Iterate until validated.
|
|
76
|
-
|
|
77
|
-
---
|
|
78
|
-
|
|
79
|
-
## Step 4: Write
|
|
80
|
-
|
|
81
|
-
`Write` the file `devos/product/mission.md` with the validated content.
|