orchestr8 2.1.3 → 2.2.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/.blueprint/agents/AGENT_SPECIFICATION_ALEX.md +3 -3
- package/.blueprint/templates/SYSTEM_SPEC.md +1 -1
- package/.business_context/README.md +27 -0
- package/README.md +18 -15
- package/SKILL.md +1 -1
- package/package.json +2 -1
- package/src/init.js +12 -1
- package/src/update.js +3 -4
|
@@ -117,8 +117,8 @@ Alex does not enforce breaking changes without explicit approval.
|
|
|
117
117
|
|
|
118
118
|
---
|
|
119
119
|
|
|
120
|
-
## 📁 Use of `.
|
|
121
|
-
Alex treats the `.
|
|
120
|
+
## 📁 Use of `.business_context`
|
|
121
|
+
Alex treats the `.business_context` directory as the **authoritative grounding** for:
|
|
122
122
|
- Domain context and constraints
|
|
123
123
|
- Policy and legislative intent (where applicable)
|
|
124
124
|
- Business outcomes and success measures
|
|
@@ -126,7 +126,7 @@ Alex treats the `.blueprint/.business_context` directory as the **authoritative
|
|
|
126
126
|
|
|
127
127
|
Alex aligns system and feature specifications to this context.
|
|
128
128
|
|
|
129
|
-
Because `.
|
|
129
|
+
Because `.business_context` varies by project, Alex:
|
|
130
130
|
- Avoids over-assumption
|
|
131
131
|
- Makes inferred interpretations explicit
|
|
132
132
|
- Highlights where business context is ambiguous or incomplete
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
# Business Context
|
|
2
|
+
|
|
3
|
+
This directory contains business context documents that help the AI agents understand your domain, stakeholders, and existing systems.
|
|
4
|
+
|
|
5
|
+
## What to include
|
|
6
|
+
|
|
7
|
+
- **Domain glossary** - Key terms and definitions specific to your business
|
|
8
|
+
- **Stakeholder information** - Who uses the system, their roles and needs
|
|
9
|
+
- **Existing system documentation** - Architecture diagrams, API docs, data models
|
|
10
|
+
- **Business rules** - Constraints, policies, and logic that govern the domain
|
|
11
|
+
- **Compliance requirements** - Regulatory or legal considerations
|
|
12
|
+
- **Integration points** - External systems and how they connect
|
|
13
|
+
|
|
14
|
+
## How agents use this
|
|
15
|
+
|
|
16
|
+
The agents (particularly Alex) reference these documents when:
|
|
17
|
+
- Creating system specifications
|
|
18
|
+
- Writing feature specifications
|
|
19
|
+
- Ensuring consistency with domain language
|
|
20
|
+
- Understanding constraints and dependencies
|
|
21
|
+
|
|
22
|
+
## Tips
|
|
23
|
+
|
|
24
|
+
- Keep documents concise and up-to-date
|
|
25
|
+
- Use markdown for consistency
|
|
26
|
+
- Link to external documentation rather than duplicating it
|
|
27
|
+
- Update as your understanding of the domain evolves
|
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
#
|
|
1
|
+
# orchestr8
|
|
2
2
|
|
|
3
3
|
A multi-agent workflow framework for automated feature development. Four specialized AI agents collaborate in sequence to take features from specification to implementation.
|
|
4
4
|
|
|
@@ -29,7 +29,7 @@ This installs the `.blueprint/` directory and `SKILL.md` into your project. If f
|
|
|
29
29
|
| `npx agent-workflow skills [agent]` | List recommended skills |
|
|
30
30
|
| `npx agent-workflow help` | Show help |
|
|
31
31
|
|
|
32
|
-
The `update` command preserves your content in `features
|
|
32
|
+
The `update` command preserves your content in `features/` and `system_specification/` while updating the framework files. Your `.business_context/` directory is separate from `.blueprint/` and unaffected by updates.
|
|
33
33
|
|
|
34
34
|
### Optional Skills
|
|
35
35
|
|
|
@@ -71,19 +71,22 @@ Update System: Alex → cascade check
|
|
|
71
71
|
## Directory Structure
|
|
72
72
|
|
|
73
73
|
```
|
|
74
|
-
|
|
75
|
-
├──
|
|
76
|
-
│ ├──
|
|
77
|
-
│ ├──
|
|
78
|
-
│ ├──
|
|
79
|
-
│
|
|
80
|
-
|
|
81
|
-
│ ├──
|
|
82
|
-
│
|
|
83
|
-
|
|
84
|
-
├──
|
|
85
|
-
├──
|
|
86
|
-
└──
|
|
74
|
+
your-project/
|
|
75
|
+
├── .blueprint/
|
|
76
|
+
│ ├── agents/ # Agent specifications
|
|
77
|
+
│ │ ├── AGENT_SPECIFICATION_ALEX.md
|
|
78
|
+
│ │ ├── AGENT_BA_CASS.md
|
|
79
|
+
│ │ ├── AGENT_TESTER_NIGEL.md
|
|
80
|
+
│ │ └── AGENT_DEVELOPER_CODEY.md
|
|
81
|
+
│ ├── templates/ # Spec templates
|
|
82
|
+
│ │ ├── SYSTEM_SPEC.md
|
|
83
|
+
│ │ └── FEATURE_SPEC.md
|
|
84
|
+
│ ├── ways_of_working/ # Development rituals
|
|
85
|
+
│ ├── features/ # Feature specs (created per feature)
|
|
86
|
+
│ └── system_specification/ # System spec (created on first run)
|
|
87
|
+
├── .business_context/ # Business context documents
|
|
88
|
+
│ └── README.md
|
|
89
|
+
└── SKILL.md
|
|
87
90
|
```
|
|
88
91
|
|
|
89
92
|
## How It Works
|
package/SKILL.md
CHANGED
|
@@ -82,7 +82,7 @@ Create a feature specification for "{slug}".
|
|
|
82
82
|
## Inputs (read these files)
|
|
83
83
|
- System Spec: .blueprint/system_specification/SYSTEM_SPEC.md
|
|
84
84
|
- Template: .blueprint/templates/FEATURE_SPEC.md
|
|
85
|
-
- Business Context: .
|
|
85
|
+
- Business Context: .business_context/
|
|
86
86
|
|
|
87
87
|
## Output (write this file)
|
|
88
88
|
Write the feature spec to: {FEAT_DIR}/FEATURE_SPEC.md
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "orchestr8",
|
|
3
|
-
"version": "2.
|
|
3
|
+
"version": "2.2.0",
|
|
4
4
|
"description": "Multi-agent workflow framework for automated feature development",
|
|
5
5
|
"main": "src/index.js",
|
|
6
6
|
"bin": {
|
|
@@ -30,6 +30,7 @@
|
|
|
30
30
|
"bin",
|
|
31
31
|
"src",
|
|
32
32
|
".blueprint",
|
|
33
|
+
".business_context",
|
|
33
34
|
"SKILL.md"
|
|
34
35
|
]
|
|
35
36
|
}
|
package/src/init.js
CHANGED
|
@@ -60,6 +60,8 @@ function updateGitignore() {
|
|
|
60
60
|
async function init() {
|
|
61
61
|
const blueprintSrc = path.join(PACKAGE_ROOT, '.blueprint');
|
|
62
62
|
const blueprintDest = path.join(TARGET_DIR, '.blueprint');
|
|
63
|
+
const businessContextSrc = path.join(PACKAGE_ROOT, '.business_context');
|
|
64
|
+
const businessContextDest = path.join(TARGET_DIR, '.business_context');
|
|
63
65
|
const skillSrc = path.join(PACKAGE_ROOT, 'SKILL.md');
|
|
64
66
|
const skillDest = path.join(TARGET_DIR, 'SKILL.md');
|
|
65
67
|
|
|
@@ -92,6 +94,15 @@ async function init() {
|
|
|
92
94
|
copyDir(blueprintSrc, blueprintDest);
|
|
93
95
|
console.log('Copied .blueprint directory');
|
|
94
96
|
|
|
97
|
+
// Copy .business_context directory
|
|
98
|
+
if (!fs.existsSync(businessContextDest)) {
|
|
99
|
+
console.log('Copying .business_context directory...');
|
|
100
|
+
copyDir(businessContextSrc, businessContextDest);
|
|
101
|
+
console.log('Copied .business_context directory');
|
|
102
|
+
} else {
|
|
103
|
+
console.log('.business_context directory already exists, skipping');
|
|
104
|
+
}
|
|
105
|
+
|
|
95
106
|
// Update .gitignore
|
|
96
107
|
updateGitignore();
|
|
97
108
|
|
|
@@ -99,7 +110,7 @@ async function init() {
|
|
|
99
110
|
agent-workflow initialized successfully!
|
|
100
111
|
|
|
101
112
|
Next steps:
|
|
102
|
-
1. Add business context to .
|
|
113
|
+
1. Add business context documents to .business_context/
|
|
103
114
|
2. Run /implement-feature in Claude Code to start your first feature
|
|
104
115
|
`);
|
|
105
116
|
}
|
package/src/update.js
CHANGED
|
@@ -8,8 +8,7 @@ const TARGET_DIR = process.cwd();
|
|
|
8
8
|
// Directories that contain user content and should NOT be overwritten
|
|
9
9
|
const USER_CONTENT_DIRS = [
|
|
10
10
|
'features',
|
|
11
|
-
'system_specification'
|
|
12
|
-
'.business_context'
|
|
11
|
+
'system_specification'
|
|
13
12
|
];
|
|
14
13
|
|
|
15
14
|
// Directories/files that should be updated
|
|
@@ -63,7 +62,7 @@ async function update() {
|
|
|
63
62
|
}
|
|
64
63
|
|
|
65
64
|
console.log('Updating agent-workflow...');
|
|
66
|
-
console.log('(Preserving: features/, system_specification
|
|
65
|
+
console.log('(Preserving: features/, system_specification/)\n');
|
|
67
66
|
|
|
68
67
|
// Update each updatable directory
|
|
69
68
|
for (const dir of UPDATABLE) {
|
|
@@ -98,7 +97,7 @@ Updated:
|
|
|
98
97
|
Preserved:
|
|
99
98
|
- .blueprint/features/
|
|
100
99
|
- .blueprint/system_specification/
|
|
101
|
-
- .
|
|
100
|
+
- .business_context/
|
|
102
101
|
`);
|
|
103
102
|
}
|
|
104
103
|
|