olympus-ai 4.5.13 → 4.5.14
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/.claude-plugin/plugin.json +1 -1
- package/dist/cli/index.js +63 -27
- package/dist/cli/index.js.map +1 -1
- package/dist/hooks/olympus-hooks.cjs +257 -257
- package/dist/installer/hooks.d.ts +47 -14
- package/dist/installer/hooks.d.ts.map +1 -1
- package/dist/installer/hooks.js +45 -77
- package/dist/installer/hooks.js.map +1 -1
- package/dist/installer/index.d.ts +8 -7
- package/dist/installer/index.d.ts.map +1 -1
- package/dist/installer/index.js +49 -46
- package/dist/installer/index.js.map +1 -1
- package/package.json +1 -1
- package/resources/config/risk-keywords.json +5 -5
- package/resources/rules/common/ascii-diagram-standards.md +115 -115
- package/resources/rules/common/content-validation.md +131 -131
- package/resources/rules/common/error-handling.md +430 -430
- package/resources/rules/common/markdown-formatting.md +170 -170
- package/resources/rules/common/overconfidence-prevention.md +100 -100
- package/resources/rules/common/pathway-behaviors.json +60 -60
- package/resources/rules/common/pathway-behaviors.md +100 -100
- package/resources/rules/common/process-overview.md +157 -157
- package/resources/rules/common/terminal-formatting.md +161 -161
- package/resources/rules/common/terminology.md +189 -189
- package/resources/rules/common/welcome-message.md +118 -118
- package/resources/rules/common/workflow-changes.md +285 -285
- package/resources/rules/construction/bolt-planning.md +153 -153
- package/resources/rules/construction/bolt-review.md +143 -143
- package/resources/rules/construction/build-and-test.md +527 -527
- package/resources/rules/construction/code-generation.md +414 -414
- package/resources/rules/construction/documentation.md +201 -201
- package/resources/rules/construction/functional-design.md +135 -135
- package/resources/rules/construction/infrastructure-design.md +110 -110
- package/resources/rules/construction/nfr-design.md +106 -106
- package/resources/rules/construction/nfr-requirements.md +118 -118
- package/resources/rules/construction/test-generation.md +112 -112
- package/resources/rules/core-workflow.md +196 -196
- package/resources/rules/inception/application-design.md +195 -195
- package/resources/rules/inception/bolt-planning.md +588 -588
- package/resources/rules/inception/reverse-engineering.md +354 -354
- package/resources/rules/inception/units-generation.md +505 -505
- package/resources/rules/inception/user-stories.md +527 -527
- package/resources/rules/inception/workspace-detection.md +82 -82
- package/resources/rules/operations/operations.md +19 -19
- package/resources/skills/brief/templates/ai-dlc-intent-brief-template.md +149 -149
- package/resources/skills/getting-started/SKILL.md +79 -79
- package/resources/templates/construction/bolt-spec-template.md +270 -270
- package/resources/templates/inception/unit-brief-template.md +188 -188
- package/resources/templates/inception/units-template.md +99 -99
|
@@ -1,82 +1,82 @@
|
|
|
1
|
-
# Workspace Detection
|
|
2
|
-
|
|
3
|
-
**Purpose**: Determine workspace state and check for existing AI-DLC projects
|
|
4
|
-
|
|
5
|
-
## Step 1: Check for Existing AI-DLC Project
|
|
6
|
-
|
|
7
|
-
Check if any `aidlc-docs/*/aidlc-state.md` exists (glob for workflow subdirectories):
|
|
8
|
-
- **If exists**: Resume the most recent workflow (load context from previous phases)
|
|
9
|
-
- **If not exists**: Continue with new project assessment
|
|
10
|
-
|
|
11
|
-
## Step 2: Count Source Files
|
|
12
|
-
|
|
13
|
-
Count source files in the workspace to determine brownfield vs greenfield classification.
|
|
14
|
-
Skip `node_modules`, `.git`, `dist`, `build`, and other common non-source directories.
|
|
15
|
-
|
|
16
|
-
- **3+ source files** → Brownfield
|
|
17
|
-
- **< 3 source files** → Greenfield
|
|
18
|
-
|
|
19
|
-
Do NOT analyze languages, build systems, or project structure here — Reverse Engineering handles that in depth for brownfield projects.
|
|
20
|
-
|
|
21
|
-
## Step 3: Determine Next Phase
|
|
22
|
-
|
|
23
|
-
**IF workspace is empty (no existing code)**:
|
|
24
|
-
- Set flag: `brownfield = false`
|
|
25
|
-
- Next phase: Requirements Analysis
|
|
26
|
-
|
|
27
|
-
**IF workspace has existing code**:
|
|
28
|
-
- Set flag: `brownfield = true`
|
|
29
|
-
- Check for existing discovery artifacts in `aidlc-docs/{workflowId}/discovery/`
|
|
30
|
-
- **IF reverse engineering artifacts exist**: Load them, skip to Requirements Analysis
|
|
31
|
-
- **IF no reverse engineering artifacts**: Next phase is Reverse Engineering
|
|
32
|
-
|
|
33
|
-
## Step 4: Create Initial State File
|
|
34
|
-
|
|
35
|
-
Create `aidlc-docs/{workflowId}/aidlc-state.md`:
|
|
36
|
-
|
|
37
|
-
```markdown
|
|
38
|
-
# AI-DLC State Tracking
|
|
39
|
-
|
|
40
|
-
## Project Information
|
|
41
|
-
- **Project Type**: [Greenfield/Brownfield]
|
|
42
|
-
- **Start Date**: [ISO timestamp]
|
|
43
|
-
- **Current Stage**: INCEPTION - Workspace Detection
|
|
44
|
-
|
|
45
|
-
## Workspace State
|
|
46
|
-
- **Source File Count**: [Number]
|
|
47
|
-
- **Reverse Engineering Needed**: [Yes/No]
|
|
48
|
-
|
|
49
|
-
## Code Location Rules
|
|
50
|
-
- **Application Code**: Workspace root (NEVER in aidlc-docs/)
|
|
51
|
-
- **Documentation**: aidlc-docs/ only
|
|
52
|
-
- **Structure patterns**: See code-generation.md Critical Rules
|
|
53
|
-
|
|
54
|
-
## Stage Progress
|
|
55
|
-
[Will be populated as workflow progresses]
|
|
56
|
-
```
|
|
57
|
-
|
|
58
|
-
## Step 5: Present Completion Message
|
|
59
|
-
|
|
60
|
-
**For Brownfield Projects:**
|
|
61
|
-
```markdown
|
|
62
|
-
# 🔍 Workspace Detection Complete
|
|
63
|
-
|
|
64
|
-
• **Project Type**: Brownfield ([N] source files detected)
|
|
65
|
-
• **Next Step**: Proceeding to **Reverse Engineering** to analyze existing codebase...
|
|
66
|
-
```
|
|
67
|
-
|
|
68
|
-
**For Greenfield Projects:**
|
|
69
|
-
```markdown
|
|
70
|
-
# 🔍 Workspace Detection Complete
|
|
71
|
-
|
|
72
|
-
Workspace analysis findings:
|
|
73
|
-
• **Project Type**: Greenfield project
|
|
74
|
-
• **Next Step**: Proceeding to **Requirements Analysis**...
|
|
75
|
-
```
|
|
76
|
-
|
|
77
|
-
## Step 6: Automatically Proceed
|
|
78
|
-
|
|
79
|
-
- **No user approval required** - this is informational only
|
|
80
|
-
- Automatically proceed to next phase:
|
|
81
|
-
- **Brownfield**: Reverse Engineering (if no existing artifacts) or Requirements Analysis (if artifacts exist)
|
|
82
|
-
- **Greenfield**: Requirements Analysis
|
|
1
|
+
# Workspace Detection
|
|
2
|
+
|
|
3
|
+
**Purpose**: Determine workspace state and check for existing AI-DLC projects
|
|
4
|
+
|
|
5
|
+
## Step 1: Check for Existing AI-DLC Project
|
|
6
|
+
|
|
7
|
+
Check if any `aidlc-docs/*/aidlc-state.md` exists (glob for workflow subdirectories):
|
|
8
|
+
- **If exists**: Resume the most recent workflow (load context from previous phases)
|
|
9
|
+
- **If not exists**: Continue with new project assessment
|
|
10
|
+
|
|
11
|
+
## Step 2: Count Source Files
|
|
12
|
+
|
|
13
|
+
Count source files in the workspace to determine brownfield vs greenfield classification.
|
|
14
|
+
Skip `node_modules`, `.git`, `dist`, `build`, and other common non-source directories.
|
|
15
|
+
|
|
16
|
+
- **3+ source files** → Brownfield
|
|
17
|
+
- **< 3 source files** → Greenfield
|
|
18
|
+
|
|
19
|
+
Do NOT analyze languages, build systems, or project structure here — Reverse Engineering handles that in depth for brownfield projects.
|
|
20
|
+
|
|
21
|
+
## Step 3: Determine Next Phase
|
|
22
|
+
|
|
23
|
+
**IF workspace is empty (no existing code)**:
|
|
24
|
+
- Set flag: `brownfield = false`
|
|
25
|
+
- Next phase: Requirements Analysis
|
|
26
|
+
|
|
27
|
+
**IF workspace has existing code**:
|
|
28
|
+
- Set flag: `brownfield = true`
|
|
29
|
+
- Check for existing discovery artifacts in `aidlc-docs/{workflowId}/discovery/`
|
|
30
|
+
- **IF reverse engineering artifacts exist**: Load them, skip to Requirements Analysis
|
|
31
|
+
- **IF no reverse engineering artifacts**: Next phase is Reverse Engineering
|
|
32
|
+
|
|
33
|
+
## Step 4: Create Initial State File
|
|
34
|
+
|
|
35
|
+
Create `aidlc-docs/{workflowId}/aidlc-state.md`:
|
|
36
|
+
|
|
37
|
+
```markdown
|
|
38
|
+
# AI-DLC State Tracking
|
|
39
|
+
|
|
40
|
+
## Project Information
|
|
41
|
+
- **Project Type**: [Greenfield/Brownfield]
|
|
42
|
+
- **Start Date**: [ISO timestamp]
|
|
43
|
+
- **Current Stage**: INCEPTION - Workspace Detection
|
|
44
|
+
|
|
45
|
+
## Workspace State
|
|
46
|
+
- **Source File Count**: [Number]
|
|
47
|
+
- **Reverse Engineering Needed**: [Yes/No]
|
|
48
|
+
|
|
49
|
+
## Code Location Rules
|
|
50
|
+
- **Application Code**: Workspace root (NEVER in aidlc-docs/)
|
|
51
|
+
- **Documentation**: aidlc-docs/ only
|
|
52
|
+
- **Structure patterns**: See code-generation.md Critical Rules
|
|
53
|
+
|
|
54
|
+
## Stage Progress
|
|
55
|
+
[Will be populated as workflow progresses]
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
## Step 5: Present Completion Message
|
|
59
|
+
|
|
60
|
+
**For Brownfield Projects:**
|
|
61
|
+
```markdown
|
|
62
|
+
# 🔍 Workspace Detection Complete
|
|
63
|
+
|
|
64
|
+
• **Project Type**: Brownfield ([N] source files detected)
|
|
65
|
+
• **Next Step**: Proceeding to **Reverse Engineering** to analyze existing codebase...
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
**For Greenfield Projects:**
|
|
69
|
+
```markdown
|
|
70
|
+
# 🔍 Workspace Detection Complete
|
|
71
|
+
|
|
72
|
+
Workspace analysis findings:
|
|
73
|
+
• **Project Type**: Greenfield project
|
|
74
|
+
• **Next Step**: Proceeding to **Requirements Analysis**...
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
## Step 6: Automatically Proceed
|
|
78
|
+
|
|
79
|
+
- **No user approval required** - this is informational only
|
|
80
|
+
- Automatically proceed to next phase:
|
|
81
|
+
- **Brownfield**: Reverse Engineering (if no existing artifacts) or Requirements Analysis (if artifacts exist)
|
|
82
|
+
- **Greenfield**: Requirements Analysis
|
|
@@ -1,19 +1,19 @@
|
|
|
1
|
-
# Operations
|
|
2
|
-
|
|
3
|
-
**Purpose**: Placeholder for future operational phases (deployment, monitoring, maintenance)
|
|
4
|
-
|
|
5
|
-
**Status**: This phase is currently a placeholder and will be expanded in future versions.
|
|
6
|
-
|
|
7
|
-
## Future Scope
|
|
8
|
-
|
|
9
|
-
The Operations phase will eventually include:
|
|
10
|
-
- Deployment planning and execution
|
|
11
|
-
- Monitoring and observability setup
|
|
12
|
-
- Incident response procedures
|
|
13
|
-
- Maintenance and support workflows
|
|
14
|
-
- Production readiness checklists
|
|
15
|
-
|
|
16
|
-
## Current State
|
|
17
|
-
|
|
18
|
-
All build and test activities have been moved to the CONSTRUCTION phase.
|
|
19
|
-
The AI-DLC workflow currently ends after the Build and Test phase in CONSTRUCTION.
|
|
1
|
+
# Operations
|
|
2
|
+
|
|
3
|
+
**Purpose**: Placeholder for future operational phases (deployment, monitoring, maintenance)
|
|
4
|
+
|
|
5
|
+
**Status**: This phase is currently a placeholder and will be expanded in future versions.
|
|
6
|
+
|
|
7
|
+
## Future Scope
|
|
8
|
+
|
|
9
|
+
The Operations phase will eventually include:
|
|
10
|
+
- Deployment planning and execution
|
|
11
|
+
- Monitoring and observability setup
|
|
12
|
+
- Incident response procedures
|
|
13
|
+
- Maintenance and support workflows
|
|
14
|
+
- Production readiness checklists
|
|
15
|
+
|
|
16
|
+
## Current State
|
|
17
|
+
|
|
18
|
+
All build and test activities have been moved to the CONSTRUCTION phase.
|
|
19
|
+
The AI-DLC workflow currently ends after the Build and Test phase in CONSTRUCTION.
|
|
@@ -1,149 +1,149 @@
|
|
|
1
|
-
# AI-DLC Intent Brief
|
|
2
|
-
|
|
3
|
-
**Author:** [Your name]
|
|
4
|
-
**Last Updated:** [Date]
|
|
5
|
-
**Status:** Draft | Ready for Mob Elaboration
|
|
6
|
-
**Project Type:** Greenfield | Brownfield
|
|
7
|
-
|
|
8
|
-
---
|
|
9
|
-
|
|
10
|
-
## Intent
|
|
11
|
-
|
|
12
|
-
_A clear, concise statement of what you want to build and why. This is the seed the AI decomposes during Inception. Write it the way you'd pitch the problem to a new team member in 60 seconds._
|
|
13
|
-
|
|
14
|
-
We need to [what the system should do] so that [who benefits] can [outcome achieved], because today [current pain point or gap].
|
|
15
|
-
|
|
16
|
-
**Example:** We need to build a consolidated reporting engine so that account managers can generate cross-account summaries in minutes instead of hours, because today they manually pull data from three separate systems and lose ~3 hours/week per person.
|
|
17
|
-
|
|
18
|
-
---
|
|
19
|
-
|
|
20
|
-
## Business Context
|
|
21
|
-
|
|
22
|
-
### Who is this for?
|
|
23
|
-
|
|
24
|
-
| Segment | Role / Persona | Why they care |
|
|
25
|
-
|---------|---------------|---------------|
|
|
26
|
-
| Primary | [e.g., Account managers with 5+ accounts] | [e.g., Directly impacted by manual reporting burden] |
|
|
27
|
-
| Secondary | [e.g., Team leads consuming rolled-up data] | [e.g., Need accurate data for planning decisions] |
|
|
28
|
-
|
|
29
|
-
### What does success look like?
|
|
30
|
-
|
|
31
|
-
_Don't over-specify metrics yet — the AI will help refine these during Mob Elaboration. Capture the directional outcomes you care about._
|
|
32
|
-
|
|
33
|
-
- [e.g., Dramatically reduce time spent on manual data pulls]
|
|
34
|
-
- [e.g., Improve accuracy of cross-account reporting]
|
|
35
|
-
- [e.g., High adoption within the first quarter post-launch]
|
|
36
|
-
|
|
37
|
-
---
|
|
38
|
-
|
|
39
|
-
## Scope Boundaries
|
|
40
|
-
|
|
41
|
-
### Explicitly Out of Scope
|
|
42
|
-
|
|
43
|
-
_This is the most important section for preventing AI over-scoping during Inception. Be specific about what you are NOT building._
|
|
44
|
-
|
|
45
|
-
- [e.g., Custom report builder — planned for a future phase]
|
|
46
|
-
- [e.g., Real-time streaming / live dashboards]
|
|
47
|
-
- [e.g., Third-party data source integrations]
|
|
48
|
-
- [e.g., Changes to the underlying data models in source systems]
|
|
49
|
-
|
|
50
|
-
### Scope Signals (In Scope, Directional)
|
|
51
|
-
|
|
52
|
-
_High-level capabilities you expect. The AI will decompose these into stories and units — don't write detailed requirements here._
|
|
53
|
-
|
|
54
|
-
- [e.g., Automated aggregation across account types A, B, and C]
|
|
55
|
-
- [e.g., Export functionality (CSV, PDF at minimum)]
|
|
56
|
-
- [e.g., Role-based access control]
|
|
57
|
-
|
|
58
|
-
---
|
|
59
|
-
|
|
60
|
-
## Constraints
|
|
61
|
-
|
|
62
|
-
_Realities the AI cannot infer. These shape the solution space before any design work begins._
|
|
63
|
-
|
|
64
|
-
### Technical Constraints
|
|
65
|
-
- [e.g., Must integrate with existing REST APIs for account types A and B]
|
|
66
|
-
- [e.g., Must work within the current frontend framework — no new UI dependencies]
|
|
67
|
-
- [e.g., Database is PostgreSQL 14; no migration budget in this phase]
|
|
68
|
-
|
|
69
|
-
### Business / Organizational Constraints
|
|
70
|
-
- [e.g., Engineering capacity: 2 backend + 1 frontend for this initiative]
|
|
71
|
-
- [e.g., Must ship before Q3 planning cycle begins]
|
|
72
|
-
- [e.g., Cannot change the existing billing data schema without Finance approval]
|
|
73
|
-
|
|
74
|
-
### Compliance / Security Constraints
|
|
75
|
-
- [e.g., Data exports must comply with SOC 2 requirements]
|
|
76
|
-
- [e.g., PII must be masked in any shared or exported reports]
|
|
77
|
-
- [e.g., All API endpoints require authentication via existing SSO]
|
|
78
|
-
|
|
79
|
-
---
|
|
80
|
-
|
|
81
|
-
## Existing System Context
|
|
82
|
-
|
|
83
|
-
_Critical for brownfield projects. Give the AI enough to understand what it's working with._
|
|
84
|
-
|
|
85
|
-
### System Landscape
|
|
86
|
-
- [e.g., Monolithic Rails app with a React frontend, deployed on AWS ECS]
|
|
87
|
-
- [e.g., Account data lives in three microservices: accounts-svc, billing-svc, usage-svc]
|
|
88
|
-
- [e.g., Current reporting is a set of ad-hoc SQL queries run manually against a read replica]
|
|
89
|
-
|
|
90
|
-
### Key Integration Points
|
|
91
|
-
- [e.g., accounts-svc API (stable, documented)]
|
|
92
|
-
- [e.g., billing-svc API (stable, documented)]
|
|
93
|
-
- [e.g., usage-svc API (undocumented, needs a spike)]
|
|
94
|
-
|
|
95
|
-
### Known Technical Debt or Risks
|
|
96
|
-
- [e.g., usage-svc has no published API contract — will need reverse engineering]
|
|
97
|
-
- [e.g., Read replica has a 15-minute replication lag]
|
|
98
|
-
|
|
99
|
-
_For greenfield projects, replace this section with a brief note on target platform/stack if known, or mark as "To be determined during Inception."_
|
|
100
|
-
|
|
101
|
-
---
|
|
102
|
-
|
|
103
|
-
## Dependencies & Risks
|
|
104
|
-
|
|
105
|
-
| Item | Type | Owner | Impact if Unresolved |
|
|
106
|
-
|------|------|-------|---------------------|
|
|
107
|
-
| [e.g., usage-svc API contract] | Technical | Backend team | Blocks integration work for account type C |
|
|
108
|
-
| [e.g., Design resource availability] | Organizational | Design lead | Delays UI work; may need async review process |
|
|
109
|
-
| [e.g., Data accuracy in source systems] | Data quality | Data team | Garbage-in/garbage-out for consolidated reports |
|
|
110
|
-
|
|
111
|
-
---
|
|
112
|
-
|
|
113
|
-
## Non-Functional Requirements (Known)
|
|
114
|
-
|
|
115
|
-
_Capture NFRs you already know. The AI-DLC workflow will evaluate these and may surface additional ones during Inception._
|
|
116
|
-
|
|
117
|
-
- **Performance:** [e.g., Report generation must complete within 30 seconds for up to 50 accounts]
|
|
118
|
-
- **Availability:** [e.g., Must meet existing platform SLA of 99.9%]
|
|
119
|
-
- **Scalability:** [e.g., Must support up to 200 concurrent users]
|
|
120
|
-
- **Accessibility:** [e.g., Must meet WCAG 2.1 AA]
|
|
121
|
-
- **Observability:** [e.g., Must integrate with existing Datadog monitoring]
|
|
122
|
-
|
|
123
|
-
---
|
|
124
|
-
|
|
125
|
-
## Stakeholders for Mob Elaboration
|
|
126
|
-
|
|
127
|
-
_Who needs to be in the room when Inception kicks off?_
|
|
128
|
-
|
|
129
|
-
| Name | Role | Why they're needed |
|
|
130
|
-
|------|------|--------------------|
|
|
131
|
-
| [Name] | Product Owner | Owns the intent and prioritization decisions |
|
|
132
|
-
| [Name] | Engineering Lead | Technical feasibility and architecture input |
|
|
133
|
-
| [Name] | QA / Test Lead | Acceptance criteria and edge case identification |
|
|
134
|
-
| [Name] | Security / Compliance | Validates NFRs and compliance constraints |
|
|
135
|
-
| [Name] | Ops / DevOps | Deployment and infrastructure considerations |
|
|
136
|
-
|
|
137
|
-
---
|
|
138
|
-
|
|
139
|
-
## Open Pre-Inception Questions
|
|
140
|
-
|
|
141
|
-
_Things you need answered BEFORE Mob Elaboration — not questions for the AI to resolve during Inception._
|
|
142
|
-
|
|
143
|
-
- [ ] [e.g., Has Finance signed off on the billing schema freeze?]
|
|
144
|
-
- [ ] [e.g., Do we have API credentials for the usage-svc staging environment?]
|
|
145
|
-
- [ ] [e.g., Is the design team available for async review during the build phase?]
|
|
146
|
-
|
|
147
|
-
---
|
|
148
|
-
|
|
149
|
-
_Once this brief is complete and pre-inception questions are resolved, trigger Mob Elaboration. The AI-DLC Inception phase will decompose the Intent into requirements, stories, and units — with the team validating every step._
|
|
1
|
+
# AI-DLC Intent Brief
|
|
2
|
+
|
|
3
|
+
**Author:** [Your name]
|
|
4
|
+
**Last Updated:** [Date]
|
|
5
|
+
**Status:** Draft | Ready for Mob Elaboration
|
|
6
|
+
**Project Type:** Greenfield | Brownfield
|
|
7
|
+
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
## Intent
|
|
11
|
+
|
|
12
|
+
_A clear, concise statement of what you want to build and why. This is the seed the AI decomposes during Inception. Write it the way you'd pitch the problem to a new team member in 60 seconds._
|
|
13
|
+
|
|
14
|
+
We need to [what the system should do] so that [who benefits] can [outcome achieved], because today [current pain point or gap].
|
|
15
|
+
|
|
16
|
+
**Example:** We need to build a consolidated reporting engine so that account managers can generate cross-account summaries in minutes instead of hours, because today they manually pull data from three separate systems and lose ~3 hours/week per person.
|
|
17
|
+
|
|
18
|
+
---
|
|
19
|
+
|
|
20
|
+
## Business Context
|
|
21
|
+
|
|
22
|
+
### Who is this for?
|
|
23
|
+
|
|
24
|
+
| Segment | Role / Persona | Why they care |
|
|
25
|
+
|---------|---------------|---------------|
|
|
26
|
+
| Primary | [e.g., Account managers with 5+ accounts] | [e.g., Directly impacted by manual reporting burden] |
|
|
27
|
+
| Secondary | [e.g., Team leads consuming rolled-up data] | [e.g., Need accurate data for planning decisions] |
|
|
28
|
+
|
|
29
|
+
### What does success look like?
|
|
30
|
+
|
|
31
|
+
_Don't over-specify metrics yet — the AI will help refine these during Mob Elaboration. Capture the directional outcomes you care about._
|
|
32
|
+
|
|
33
|
+
- [e.g., Dramatically reduce time spent on manual data pulls]
|
|
34
|
+
- [e.g., Improve accuracy of cross-account reporting]
|
|
35
|
+
- [e.g., High adoption within the first quarter post-launch]
|
|
36
|
+
|
|
37
|
+
---
|
|
38
|
+
|
|
39
|
+
## Scope Boundaries
|
|
40
|
+
|
|
41
|
+
### Explicitly Out of Scope
|
|
42
|
+
|
|
43
|
+
_This is the most important section for preventing AI over-scoping during Inception. Be specific about what you are NOT building._
|
|
44
|
+
|
|
45
|
+
- [e.g., Custom report builder — planned for a future phase]
|
|
46
|
+
- [e.g., Real-time streaming / live dashboards]
|
|
47
|
+
- [e.g., Third-party data source integrations]
|
|
48
|
+
- [e.g., Changes to the underlying data models in source systems]
|
|
49
|
+
|
|
50
|
+
### Scope Signals (In Scope, Directional)
|
|
51
|
+
|
|
52
|
+
_High-level capabilities you expect. The AI will decompose these into stories and units — don't write detailed requirements here._
|
|
53
|
+
|
|
54
|
+
- [e.g., Automated aggregation across account types A, B, and C]
|
|
55
|
+
- [e.g., Export functionality (CSV, PDF at minimum)]
|
|
56
|
+
- [e.g., Role-based access control]
|
|
57
|
+
|
|
58
|
+
---
|
|
59
|
+
|
|
60
|
+
## Constraints
|
|
61
|
+
|
|
62
|
+
_Realities the AI cannot infer. These shape the solution space before any design work begins._
|
|
63
|
+
|
|
64
|
+
### Technical Constraints
|
|
65
|
+
- [e.g., Must integrate with existing REST APIs for account types A and B]
|
|
66
|
+
- [e.g., Must work within the current frontend framework — no new UI dependencies]
|
|
67
|
+
- [e.g., Database is PostgreSQL 14; no migration budget in this phase]
|
|
68
|
+
|
|
69
|
+
### Business / Organizational Constraints
|
|
70
|
+
- [e.g., Engineering capacity: 2 backend + 1 frontend for this initiative]
|
|
71
|
+
- [e.g., Must ship before Q3 planning cycle begins]
|
|
72
|
+
- [e.g., Cannot change the existing billing data schema without Finance approval]
|
|
73
|
+
|
|
74
|
+
### Compliance / Security Constraints
|
|
75
|
+
- [e.g., Data exports must comply with SOC 2 requirements]
|
|
76
|
+
- [e.g., PII must be masked in any shared or exported reports]
|
|
77
|
+
- [e.g., All API endpoints require authentication via existing SSO]
|
|
78
|
+
|
|
79
|
+
---
|
|
80
|
+
|
|
81
|
+
## Existing System Context
|
|
82
|
+
|
|
83
|
+
_Critical for brownfield projects. Give the AI enough to understand what it's working with._
|
|
84
|
+
|
|
85
|
+
### System Landscape
|
|
86
|
+
- [e.g., Monolithic Rails app with a React frontend, deployed on AWS ECS]
|
|
87
|
+
- [e.g., Account data lives in three microservices: accounts-svc, billing-svc, usage-svc]
|
|
88
|
+
- [e.g., Current reporting is a set of ad-hoc SQL queries run manually against a read replica]
|
|
89
|
+
|
|
90
|
+
### Key Integration Points
|
|
91
|
+
- [e.g., accounts-svc API (stable, documented)]
|
|
92
|
+
- [e.g., billing-svc API (stable, documented)]
|
|
93
|
+
- [e.g., usage-svc API (undocumented, needs a spike)]
|
|
94
|
+
|
|
95
|
+
### Known Technical Debt or Risks
|
|
96
|
+
- [e.g., usage-svc has no published API contract — will need reverse engineering]
|
|
97
|
+
- [e.g., Read replica has a 15-minute replication lag]
|
|
98
|
+
|
|
99
|
+
_For greenfield projects, replace this section with a brief note on target platform/stack if known, or mark as "To be determined during Inception."_
|
|
100
|
+
|
|
101
|
+
---
|
|
102
|
+
|
|
103
|
+
## Dependencies & Risks
|
|
104
|
+
|
|
105
|
+
| Item | Type | Owner | Impact if Unresolved |
|
|
106
|
+
|------|------|-------|---------------------|
|
|
107
|
+
| [e.g., usage-svc API contract] | Technical | Backend team | Blocks integration work for account type C |
|
|
108
|
+
| [e.g., Design resource availability] | Organizational | Design lead | Delays UI work; may need async review process |
|
|
109
|
+
| [e.g., Data accuracy in source systems] | Data quality | Data team | Garbage-in/garbage-out for consolidated reports |
|
|
110
|
+
|
|
111
|
+
---
|
|
112
|
+
|
|
113
|
+
## Non-Functional Requirements (Known)
|
|
114
|
+
|
|
115
|
+
_Capture NFRs you already know. The AI-DLC workflow will evaluate these and may surface additional ones during Inception._
|
|
116
|
+
|
|
117
|
+
- **Performance:** [e.g., Report generation must complete within 30 seconds for up to 50 accounts]
|
|
118
|
+
- **Availability:** [e.g., Must meet existing platform SLA of 99.9%]
|
|
119
|
+
- **Scalability:** [e.g., Must support up to 200 concurrent users]
|
|
120
|
+
- **Accessibility:** [e.g., Must meet WCAG 2.1 AA]
|
|
121
|
+
- **Observability:** [e.g., Must integrate with existing Datadog monitoring]
|
|
122
|
+
|
|
123
|
+
---
|
|
124
|
+
|
|
125
|
+
## Stakeholders for Mob Elaboration
|
|
126
|
+
|
|
127
|
+
_Who needs to be in the room when Inception kicks off?_
|
|
128
|
+
|
|
129
|
+
| Name | Role | Why they're needed |
|
|
130
|
+
|------|------|--------------------|
|
|
131
|
+
| [Name] | Product Owner | Owns the intent and prioritization decisions |
|
|
132
|
+
| [Name] | Engineering Lead | Technical feasibility and architecture input |
|
|
133
|
+
| [Name] | QA / Test Lead | Acceptance criteria and edge case identification |
|
|
134
|
+
| [Name] | Security / Compliance | Validates NFRs and compliance constraints |
|
|
135
|
+
| [Name] | Ops / DevOps | Deployment and infrastructure considerations |
|
|
136
|
+
|
|
137
|
+
---
|
|
138
|
+
|
|
139
|
+
## Open Pre-Inception Questions
|
|
140
|
+
|
|
141
|
+
_Things you need answered BEFORE Mob Elaboration — not questions for the AI to resolve during Inception._
|
|
142
|
+
|
|
143
|
+
- [ ] [e.g., Has Finance signed off on the billing schema freeze?]
|
|
144
|
+
- [ ] [e.g., Do we have API credentials for the usage-svc staging environment?]
|
|
145
|
+
- [ ] [e.g., Is the design team available for async review during the build phase?]
|
|
146
|
+
|
|
147
|
+
---
|
|
148
|
+
|
|
149
|
+
_Once this brief is complete and pre-inception questions are resolved, trigger Mob Elaboration. The AI-DLC Inception phase will decompose the Intent into requirements, stories, and units — with the team validating every step._
|
|
@@ -1,79 +1,79 @@
|
|
|
1
|
-
---
|
|
2
|
-
description: Guided introduction to Olympus — capabilities overview and your first /plan workflow
|
|
3
|
-
---
|
|
4
|
-
|
|
5
|
-
# Welcome to Olympus
|
|
6
|
-
|
|
7
|
-
Olympus is a multi-agent orchestration layer for Claude Code. It gives you 20+ specialized AI agents, a structured development workflow (`/plan`), and a self-learning system that improves with every session.
|
|
8
|
-
|
|
9
|
-
This guide walks you through the key capabilities and gets you to a real result in your project in under 5 minutes.
|
|
10
|
-
|
|
11
|
-
---
|
|
12
|
-
|
|
13
|
-
## What Olympus Can Do
|
|
14
|
-
|
|
15
|
-
**Multi-agent orchestration** — Olympus automatically delegates work to specialist agents (architects, searchers, frontend engineers, QA testers) and routes each task to the right model tier (Haiku/Sonnet/Opus) to balance speed and quality.
|
|
16
|
-
|
|
17
|
-
**`/plan <task>`** — The AI-DLC structured workflow. Olympus interviews you to clarify requirements, produces a written plan you approve, then delegates construction to the right agents. Best for features, refactors, and anything non-trivial.
|
|
18
|
-
|
|
19
|
-
**`/ultrawork <task>`** — Maximum performance mode. Runs agents in parallel, doesn't wait for confirmation. Use when you need speed and the task is clear.
|
|
20
|
-
|
|
21
|
-
**`/ascent <task>`** — Persistence loop. Olympus will not stop until every todo is complete. Use when you need guaranteed completion.
|
|
22
|
-
|
|
23
|
-
**Self-learning** — Olympus records patterns and preferences across sessions. Future runs benefit from what past runs discovered.
|
|
24
|
-
|
|
25
|
-
---
|
|
26
|
-
|
|
27
|
-
## Your First Real Task
|
|
28
|
-
|
|
29
|
-
Let's use `/plan` on your actual project right now.
|
|
30
|
-
|
|
31
|
-
**Step 1 — Open Claude Code in your project directory** (you're likely already there).
|
|
32
|
-
|
|
33
|
-
**Step 2 — Pick a real task.** Think of something you've been meaning to do:
|
|
34
|
-
- Add a feature or endpoint
|
|
35
|
-
- Refactor a messy module
|
|
36
|
-
- Write tests for an untested area
|
|
37
|
-
- Fix a known bug or improve error handling
|
|
38
|
-
|
|
39
|
-
**Step 3 — Start the plan.** Type something like:
|
|
40
|
-
|
|
41
|
-
```
|
|
42
|
-
/plan add input validation to the user registration flow
|
|
43
|
-
```
|
|
44
|
-
|
|
45
|
-
or
|
|
46
|
-
|
|
47
|
-
```
|
|
48
|
-
/plan refactor the database layer to use the repository pattern
|
|
49
|
-
```
|
|
50
|
-
|
|
51
|
-
**What happens next:**
|
|
52
|
-
1. **Inception** — Olympus interviews you with targeted questions to clarify scope, edge cases, and constraints. Answer honestly; vague answers produce vague plans.
|
|
53
|
-
2. **Plan review** — You'll see a written plan before any code is touched. Request changes or approve it.
|
|
54
|
-
3. **Construction** — Olympus delegates implementation to specialist agents. You can watch progress or step away.
|
|
55
|
-
|
|
56
|
-
The whole cycle for a medium feature takes 15-30 minutes of AI work, with you approving at key checkpoints.
|
|
57
|
-
|
|
58
|
-
---
|
|
59
|
-
|
|
60
|
-
## Quick Reference
|
|
61
|
-
|
|
62
|
-
| Command | When to use |
|
|
63
|
-
|---------|-------------|
|
|
64
|
-
| `/plan <task>` | Features, refactors, anything that needs a plan first |
|
|
65
|
-
| `/ultrawork <task>` | Well-defined tasks where speed matters |
|
|
66
|
-
| `/ascent <task>` | Must-complete work — Olympus won't stop until done |
|
|
67
|
-
| `/deepsearch <query>` | Find anything in the codebase |
|
|
68
|
-
| `/analyze <target>` | Deep investigation of a file, function, or bug |
|
|
69
|
-
| `/olympus-default` | Make Olympus your default mode for every session |
|
|
70
|
-
|
|
71
|
-
---
|
|
72
|
-
|
|
73
|
-
## Next Steps
|
|
74
|
-
|
|
75
|
-
- Run `/olympus-default` to activate Olympus automatically in every Claude Code session.
|
|
76
|
-
- Run `/plan` on your first real task.
|
|
77
|
-
- Run `/deepsearch` or `/analyze` to explore unfamiliar parts of your codebase.
|
|
78
|
-
|
|
79
|
-
For full documentation, see the README or run `olympus info`.
|
|
1
|
+
---
|
|
2
|
+
description: Guided introduction to Olympus — capabilities overview and your first /plan workflow
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
# Welcome to Olympus
|
|
6
|
+
|
|
7
|
+
Olympus is a multi-agent orchestration layer for Claude Code. It gives you 20+ specialized AI agents, a structured development workflow (`/plan`), and a self-learning system that improves with every session.
|
|
8
|
+
|
|
9
|
+
This guide walks you through the key capabilities and gets you to a real result in your project in under 5 minutes.
|
|
10
|
+
|
|
11
|
+
---
|
|
12
|
+
|
|
13
|
+
## What Olympus Can Do
|
|
14
|
+
|
|
15
|
+
**Multi-agent orchestration** — Olympus automatically delegates work to specialist agents (architects, searchers, frontend engineers, QA testers) and routes each task to the right model tier (Haiku/Sonnet/Opus) to balance speed and quality.
|
|
16
|
+
|
|
17
|
+
**`/plan <task>`** — The AI-DLC structured workflow. Olympus interviews you to clarify requirements, produces a written plan you approve, then delegates construction to the right agents. Best for features, refactors, and anything non-trivial.
|
|
18
|
+
|
|
19
|
+
**`/ultrawork <task>`** — Maximum performance mode. Runs agents in parallel, doesn't wait for confirmation. Use when you need speed and the task is clear.
|
|
20
|
+
|
|
21
|
+
**`/ascent <task>`** — Persistence loop. Olympus will not stop until every todo is complete. Use when you need guaranteed completion.
|
|
22
|
+
|
|
23
|
+
**Self-learning** — Olympus records patterns and preferences across sessions. Future runs benefit from what past runs discovered.
|
|
24
|
+
|
|
25
|
+
---
|
|
26
|
+
|
|
27
|
+
## Your First Real Task
|
|
28
|
+
|
|
29
|
+
Let's use `/plan` on your actual project right now.
|
|
30
|
+
|
|
31
|
+
**Step 1 — Open Claude Code in your project directory** (you're likely already there).
|
|
32
|
+
|
|
33
|
+
**Step 2 — Pick a real task.** Think of something you've been meaning to do:
|
|
34
|
+
- Add a feature or endpoint
|
|
35
|
+
- Refactor a messy module
|
|
36
|
+
- Write tests for an untested area
|
|
37
|
+
- Fix a known bug or improve error handling
|
|
38
|
+
|
|
39
|
+
**Step 3 — Start the plan.** Type something like:
|
|
40
|
+
|
|
41
|
+
```
|
|
42
|
+
/plan add input validation to the user registration flow
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
or
|
|
46
|
+
|
|
47
|
+
```
|
|
48
|
+
/plan refactor the database layer to use the repository pattern
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
**What happens next:**
|
|
52
|
+
1. **Inception** — Olympus interviews you with targeted questions to clarify scope, edge cases, and constraints. Answer honestly; vague answers produce vague plans.
|
|
53
|
+
2. **Plan review** — You'll see a written plan before any code is touched. Request changes or approve it.
|
|
54
|
+
3. **Construction** — Olympus delegates implementation to specialist agents. You can watch progress or step away.
|
|
55
|
+
|
|
56
|
+
The whole cycle for a medium feature takes 15-30 minutes of AI work, with you approving at key checkpoints.
|
|
57
|
+
|
|
58
|
+
---
|
|
59
|
+
|
|
60
|
+
## Quick Reference
|
|
61
|
+
|
|
62
|
+
| Command | When to use |
|
|
63
|
+
|---------|-------------|
|
|
64
|
+
| `/plan <task>` | Features, refactors, anything that needs a plan first |
|
|
65
|
+
| `/ultrawork <task>` | Well-defined tasks where speed matters |
|
|
66
|
+
| `/ascent <task>` | Must-complete work — Olympus won't stop until done |
|
|
67
|
+
| `/deepsearch <query>` | Find anything in the codebase |
|
|
68
|
+
| `/analyze <target>` | Deep investigation of a file, function, or bug |
|
|
69
|
+
| `/olympus-default` | Make Olympus your default mode for every session |
|
|
70
|
+
|
|
71
|
+
---
|
|
72
|
+
|
|
73
|
+
## Next Steps
|
|
74
|
+
|
|
75
|
+
- Run `/olympus-default` to activate Olympus automatically in every Claude Code session.
|
|
76
|
+
- Run `/plan` on your first real task.
|
|
77
|
+
- Run `/deepsearch` or `/analyze` to explore unfamiliar parts of your codebase.
|
|
78
|
+
|
|
79
|
+
For full documentation, see the README or run `olympus info`.
|