build lite version of bmm
This commit is contained in:
Nguyen Viet Hung
parent
7d3d51ff4f
commit
7e2966c1ae
19
CHANGELOG.md
19
CHANGELOG.md
|
|
@ -35,12 +35,14 @@
|
|||
|
||||
**Module Restructuring:**
|
||||
|
||||
|
||||
| Module | Status | New Location |
|
||||
| ------------------------------------- | ------------------------------------------------- | ------------------------------------------------------- |
|
||||
| **bmad-builder** | Near beta, with docs and walkthroughs coming soon | `bmad-code-org/bmad-builder` |
|
||||
| **CIS** (Creative Intelligence Suite) | Published as npm package | `bmad-code-org/bmad-module-creative-intelligence-suite` |
|
||||
| **Game Dev Studio** | Published as npm package | `bmad-code-org/bmad-module-game-dev-studio` |
|
||||
|
||||
|
||||
### 🔧 Installer & CLI Improvements
|
||||
|
||||
**UnifiedInstaller Architecture:**
|
||||
|
|
@ -491,6 +493,7 @@ Located in `src/modules/bmb/workflows/agent/data/`:
|
|||
- **Installer Cleanup**: Removed unused configuration code from BMM installer
|
||||
|
||||
**Planning Artifacts Path:**
|
||||
|
||||
- Default: `planning_artifacts/` (configurable in module.yaml)
|
||||
- Previous: `docs/`
|
||||
- Benefit: Clear separation between planning work and permanent documentation
|
||||
|
|
@ -630,7 +633,7 @@ Located in `src/modules/bmb/workflows/agent/data/`:
|
|||
|
||||
**Installer Stability:**
|
||||
|
||||
- **Fixed \_bmad Folder Stutter**: Resolved issue with duplicate \_bmad folder creation when applying agent custom files
|
||||
- **Fixed bmad Folder Stutter**: Resolved issue with duplicate bmad folder creation when applying agent custom files
|
||||
- **Cleaner Installation**: Removed unnecessary backup file that was causing bloat in the installer
|
||||
- **Streamlined Agent Customization**: Fixed path handling for agent custom files to prevent folder duplication
|
||||
|
||||
|
|
@ -654,11 +657,9 @@ Located in `src/modules/bmb/workflows/agent/data/`:
|
|||
- Engine-specific expertise: Unity, Unreal, Godot testing frameworks
|
||||
- Comprehensive knowledge base with 15+ testing topics
|
||||
- Complete testing workflows: test-framework, test-design, automate, playtest-plan, performance-test, test-review
|
||||
|
||||
- **New Game Solo Dev Agent (Indie)**: Rapid prototyping and iteration specialist
|
||||
- Quick-flow workflows optimized for solo/small team development
|
||||
- Streamlined development process for indie game creators
|
||||
|
||||
- **Production Workflow Alignment**: BMGD 4-production now fully aligned with BMM 4-implementation
|
||||
- Removed obsolete workflows: story-done, story-ready, story-context, epic-tech-context
|
||||
- Added sprint-status workflow for project tracking
|
||||
|
|
@ -678,11 +679,9 @@ Located in `src/modules/bmb/workflows/agent/data/`:
|
|||
- Game-specific project levels (Game Jam → AAA)
|
||||
- Support for gamedev and quickflow paths
|
||||
- Project initialization workflow
|
||||
|
||||
- **create-tech-spec**: Game-focused technical specification workflow
|
||||
- Engine-aware (Unity/Unreal/Godot) specifications
|
||||
- Performance and gameplay feel considerations
|
||||
|
||||
- **Enhanced Documentation**: Complete documentation suite with 9 guides
|
||||
- agents-guide.md: Reference for all 6 agents
|
||||
- workflows-guide.md: Complete workflow documentation
|
||||
|
|
@ -925,9 +924,9 @@ Located in `src/modules/bmb/workflows/agent/data/`:
|
|||
### ⚠️ Breaking Changes
|
||||
|
||||
1. **module.yaml Configuration**: All modules must now use `module.yaml` instead of `_module-installer/install-config.yaml`
|
||||
- Core modules updated automatically
|
||||
- Custom modules will need to rename their configuration file
|
||||
- Module builder templates generate new format
|
||||
- Core modules updated automatically
|
||||
- Custom modules will need to rename their configuration file
|
||||
- Module builder templates generate new format
|
||||
|
||||
### 📦 New Dependencies
|
||||
|
||||
|
|
@ -1105,7 +1104,7 @@ Located in `src/modules/bmb/workflows/agent/data/`:
|
|||
- **Frame Expert Agent**: New Excalidraw specialist with 4 diagram workflows
|
||||
- **Time Estimate Prohibition**: Warnings across 33 workflows acknowledging AI's impact on development speed
|
||||
- **Platform-Specific Commands**: ide-only/web-only fields filter menu items by environment
|
||||
- **Agent Customization**: Enhanced memory/prompts merging via \*.customize.yaml files
|
||||
- **Agent Customization**: Enhanced memory/prompts merging via .customize.yaml files
|
||||
|
||||
## [6.0.0-alpha.9]
|
||||
|
||||
|
|
@ -1485,4 +1484,4 @@ The original BMAD Method was a tech demo showcasing how different custom agile p
|
|||
npx bmad-method
|
||||
```
|
||||
|
||||
For detailed release notes, see the [GitHub releases page](https://github.com/bmad-code-org/BMAD-METHOD/releases).
|
||||
For detailed release notes, see the [GitHub releases page](https://github.com/bmad-code-org/BMAD-METHOD/releases).
|
||||
|
|
@ -0,0 +1,107 @@
|
|||
# RMTN Developer Suite
|
||||
|
||||
A 'Senior Developer in a Box' for elite solo developers.
|
||||
|
||||
Automates context management and enforces a 'Plan -> Execute' workflow.
|
||||
|
||||
---
|
||||
|
||||
## Overview
|
||||
|
||||
A "Senior Developer in a Box" that automates context-keeping and planning overhead, allowing a solo developer to move with the speed and quality of a full team. The "Standard of Excellence for Solo Devs" enforces a "Plan → Execute" discipline with automated context management.
|
||||
|
||||
---
|
||||
|
||||
## Installation
|
||||
|
||||
```bash
|
||||
bmad install rmtn-solo-dev
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Quick Start
|
||||
|
||||
1. **Onboard:** Run `[SC] Scan Project` with Mimir to generate your Saga (PRD/Arch).
|
||||
2. **Plan:** Use `[NQ] New Quest` with Thor to plan your first feature.
|
||||
3. **Execute:** Run `[EX] Execute Quest` to implement the plan.
|
||||
|
||||
**For detailed documentation, see [docs/](docs/).**
|
||||
|
||||
---
|
||||
|
||||
## Components
|
||||
|
||||
### Agents
|
||||
|
||||
- **Mimir (The Sage):** Context Keeper, Analyst.
|
||||
- **Thor (The Builder):** Implementation, Execution.
|
||||
|
||||
### Workflows
|
||||
|
||||
- **Scan Project:** Scans codebase to generate Saga (PRD/Arch).
|
||||
- **New Quest:** Plans a new feature (Approach scoring + Tech Spec).
|
||||
- **Execute Quest:** Implements a planned Quest step-by-step.
|
||||
- **Update Saga:** Updates Saga based on completed Quests.
|
||||
- **Quick Fix:** Rapidly fixes bugs without full Quest ceremony.
|
||||
|
||||
---
|
||||
|
||||
## Configuration
|
||||
|
||||
The module supports these configuration options (set during installation):
|
||||
|
||||
- `saga_folder`: Where should the Saga (Context/Arch) be stored?
|
||||
- `quests_folder`: Where should Quests be stored?
|
||||
|
||||
---
|
||||
|
||||
## Module Structure
|
||||
|
||||
```
|
||||
rmtn-solo-dev/
|
||||
├── module.yaml
|
||||
├── README.md
|
||||
├── TODO.md
|
||||
├── docs/
|
||||
│ ├── getting-started.md
|
||||
│ ├── agents.md
|
||||
│ ├── workflows.md
|
||||
│ └── examples.md
|
||||
├── agents/
|
||||
├── workflows/
|
||||
└── _module-installer/
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Documentation
|
||||
|
||||
For detailed user guides and documentation, see the **[docs/](docs/)** folder:
|
||||
- [Getting Started](docs/getting-started.md)
|
||||
- [Agents Reference](docs/agents.md)
|
||||
- [Workflows Reference](docs/workflows.md)
|
||||
- [Examples](docs/examples.md)
|
||||
|
||||
---
|
||||
|
||||
## Development Status
|
||||
|
||||
This module is currently in development. The following components are planned:
|
||||
|
||||
- [ ] Agents: 2 agents
|
||||
- [ ] Workflows: 5 workflows
|
||||
|
||||
See TODO.md for detailed status.
|
||||
|
||||
---
|
||||
|
||||
## Author
|
||||
|
||||
Created via BMAD Module workflow
|
||||
|
||||
---
|
||||
|
||||
## License
|
||||
|
||||
Part of the BMAD framework.
|
||||
|
|
@ -0,0 +1,65 @@
|
|||
# TODO: RMTN Developer Suite
|
||||
|
||||
Development roadmap for rmtn-solo-dev module.
|
||||
|
||||
---
|
||||
|
||||
## Agents to Build
|
||||
|
||||
- [ ] Mimir (Context Keeper)
|
||||
- Use: `bmad:bmb:agents:agent-builder`
|
||||
- Spec: `agents/mimir.spec.md`
|
||||
- [ ] Thor (Implementation Lead)
|
||||
- Use: `bmad:bmb:agents:agent-builder`
|
||||
- Spec: `agents/thor.spec.md`
|
||||
|
||||
---
|
||||
|
||||
## Workflows to Build
|
||||
|
||||
- [ ] scan-project
|
||||
- Use: `bmad:bmb:workflows:workflow` or `/workflow`
|
||||
- Spec: `workflows/scan-project/scan-project.spec.md`
|
||||
- [ ] new-quest
|
||||
- Use: `bmad:bmb:workflows:workflow` or `/workflow`
|
||||
- Spec: `workflows/new-quest/new-quest.spec.md`
|
||||
- [ ] execute-quest
|
||||
- Use: `bmad:bmb:workflows:workflow` or `/workflow`
|
||||
- Spec: `workflows/execute-quest/execute-quest.spec.md`
|
||||
- [ ] update-saga
|
||||
- Use: `bmad:bmb:workflows:workflow` or `/workflow`
|
||||
- Spec: `workflows/update-saga/update-saga.spec.md`
|
||||
- [ ] quick-fix
|
||||
- Use: `bmad:bmb:workflows:workflow` or `/workflow`
|
||||
- Spec: `workflows/quick-fix/quick-fix.spec.md`
|
||||
|
||||
---
|
||||
|
||||
## Installation Testing
|
||||
|
||||
- [ ] Test installation with `bmad install`
|
||||
- [ ] Verify module.yaml prompts work correctly
|
||||
- [ ] Test installer.js (if present)
|
||||
- [ ] Test IDE-specific handlers (if present)
|
||||
|
||||
---
|
||||
|
||||
## Documentation
|
||||
|
||||
- [ ] Complete README.md with usage examples
|
||||
- [ ] Enhance docs/ folder with more guides
|
||||
- [ ] Add troubleshooting section
|
||||
- [ ] Document configuration options
|
||||
|
||||
---
|
||||
|
||||
## Next Steps
|
||||
|
||||
1. Build agents using create-agent workflow
|
||||
2. Build workflows using create-workflow workflow
|
||||
3. Test installation and functionality
|
||||
4. Iterate based on testing
|
||||
|
||||
---
|
||||
|
||||
_Last updated: 2026-01-27_
|
||||
|
|
@ -0,0 +1,72 @@
|
|||
const fs = require('fs-extra');
|
||||
const path = require('node:path');
|
||||
const chalk = require('chalk');
|
||||
const platformCodes = require(path.join(__dirname, '../../../../tools/cli/lib/platform-codes'));
|
||||
|
||||
/**
|
||||
* RMTN Developer Suite Installer
|
||||
*/
|
||||
async function install(options) {
|
||||
const { projectRoot, config, installedIDEs, logger } = options;
|
||||
|
||||
try {
|
||||
logger.log(chalk.blue('Installing RMTN Developer Suite...'));
|
||||
|
||||
// Create Saga directory
|
||||
if (config['saga_folder']) {
|
||||
const sagaConfig = config['saga_folder'].replace('{project-root}/', '');
|
||||
const sagaPath = path.join(projectRoot, sagaConfig);
|
||||
if (!(await fs.pathExists(sagaPath))) {
|
||||
logger.log(chalk.yellow(`Creating Saga directory: ${sagaConfig}`));
|
||||
await fs.ensureDir(sagaPath);
|
||||
}
|
||||
}
|
||||
|
||||
// Create Quests directory
|
||||
if (config['quests_folder']) {
|
||||
const questsConfig = config['quests_folder'].replace('{project-root}/', '');
|
||||
const questsPath = path.join(projectRoot, questsConfig);
|
||||
if (!(await fs.pathExists(questsPath))) {
|
||||
logger.log(chalk.yellow(`Creating Quests directory: ${questsConfig}`));
|
||||
await fs.ensureDir(questsPath);
|
||||
}
|
||||
}
|
||||
|
||||
// IDE-specific configuration
|
||||
if (installedIDEs && installedIDEs.length > 0) {
|
||||
logger.log(chalk.cyan(`Configuring for IDEs: ${installedIDEs.join(', ')}`));
|
||||
for (const ide of installedIDEs) {
|
||||
await configureForIDE(ide, projectRoot, config, logger);
|
||||
}
|
||||
}
|
||||
|
||||
logger.log(chalk.green('✓ RMTN Developer Suite installation complete'));
|
||||
return true;
|
||||
} catch (error) {
|
||||
logger.error(chalk.red(`Error installing module: ${error.message}`));
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
async function configureForIDE(ide, projectRoot, config, logger) {
|
||||
// Simple check for now, can be expanded with full platform code validation
|
||||
// if (!platformCodes.isValidPlatform(ide)) { ... }
|
||||
|
||||
const platformSpecificPath = path.join(__dirname, 'platform-specifics', `${ide}.js`);
|
||||
|
||||
try {
|
||||
if (await fs.pathExists(platformSpecificPath)) {
|
||||
const platformHandler = require(platformSpecificPath);
|
||||
if (typeof platformHandler.install === 'function') {
|
||||
await platformHandler.install({ projectRoot, config, logger });
|
||||
}
|
||||
} else {
|
||||
// Optionally log that no specific handler exists for this IDE if that's expected behavior
|
||||
// logger.log(chalk.dim(`No specific configuration for ${ide}`));
|
||||
}
|
||||
} catch (error) {
|
||||
logger.warn(chalk.yellow(`Warning: Could not configure ${ide}: ${error.message}`));
|
||||
}
|
||||
}
|
||||
|
||||
module.exports = { install };
|
||||
|
|
@ -0,0 +1,14 @@
|
|||
/**
|
||||
* Configure module for Amp Code
|
||||
*/
|
||||
async function install(options) {
|
||||
const { projectRoot, config, logger } = options;
|
||||
try {
|
||||
logger.log(chalk.dim(' Configuring Amp Code integration...'));
|
||||
return true;
|
||||
} catch (error) {
|
||||
logger.warn(chalk.yellow(` Warning: ${error.message}`));
|
||||
return false;
|
||||
}
|
||||
}
|
||||
module.exports = { install };
|
||||
|
|
@ -0,0 +1,14 @@
|
|||
/**
|
||||
* Configure module for Claude Code
|
||||
*/
|
||||
async function install(options) {
|
||||
const { projectRoot, config, logger } = options;
|
||||
try {
|
||||
logger.log(chalk.dim(' Configuring Claude Code integration...'));
|
||||
return true;
|
||||
} catch (error) {
|
||||
logger.warn(chalk.yellow(` Warning: ${error.message}`));
|
||||
return false;
|
||||
}
|
||||
}
|
||||
module.exports = { install };
|
||||
|
|
@ -0,0 +1,15 @@
|
|||
/**
|
||||
* Configure module for Cursor
|
||||
*/
|
||||
async function install(options) {
|
||||
const { projectRoot, config, logger } = options;
|
||||
try {
|
||||
logger.log(chalk.dim(' Configuring Cursor integration...'));
|
||||
// TODO: Add Cursor-specific rule generation here
|
||||
return true;
|
||||
} catch (error) {
|
||||
logger.warn(chalk.yellow(` Warning: ${error.message}`));
|
||||
return false;
|
||||
}
|
||||
}
|
||||
module.exports = { install };
|
||||
|
|
@ -0,0 +1,14 @@
|
|||
/**
|
||||
* Configure module for OpenCode
|
||||
*/
|
||||
async function install(options) {
|
||||
const { projectRoot, config, logger } = options;
|
||||
try {
|
||||
logger.log(chalk.dim(' Configuring OpenCode integration...'));
|
||||
return true;
|
||||
} catch (error) {
|
||||
logger.warn(chalk.yellow(` Warning: ${error.message}`));
|
||||
return false;
|
||||
}
|
||||
}
|
||||
module.exports = { install };
|
||||
|
|
@ -0,0 +1,77 @@
|
|||
# Agent Specification: mimir
|
||||
|
||||
**Module:** rmtn-solo-dev
|
||||
**Status:** Placeholder — To be created via create-agent workflow
|
||||
**Created:** 2026-01-27
|
||||
|
||||
---
|
||||
|
||||
## Agent Metadata
|
||||
|
||||
```yaml
|
||||
agent:
|
||||
metadata:
|
||||
id: "_bmad/rmtn-solo-dev/agents/mimir.md"
|
||||
name: The Sage
|
||||
title: Context Keeper
|
||||
icon: 📜
|
||||
module: rmtn-solo-dev
|
||||
hasSidecar: false
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Agent Persona
|
||||
|
||||
### Role
|
||||
|
||||
Context Keeper, Analyst. Scans codebase, maintains "Saga" (PRD/Arch), ensures consistency.
|
||||
|
||||
### Identity
|
||||
|
||||
Mimir, the ancient Sage. The keeper of memory and wisdom.
|
||||
|
||||
### Communication Style
|
||||
|
||||
Wise, ancient, observant. Uses thematic language ("I cast my eye upon the code", "The threads of fate are complex") but remains professional and clear.
|
||||
|
||||
### Principles
|
||||
|
||||
- The Saga is the source of truth.
|
||||
- Context must be accurate before action is taken.
|
||||
- Observe all, miss nothing.
|
||||
|
||||
---
|
||||
|
||||
## Agent Menu
|
||||
|
||||
### Planned Commands
|
||||
|
||||
| Trigger | Command | Description | Workflow |
|
||||
|---------|---------|-------------|----------|
|
||||
| [SC] | Scan Project | Scans codebase to generate Saga (PRD/Arch) | scan-project |
|
||||
| [US] | Update Saga | Updates Saga based on completed Quests | update-saga |
|
||||
|
||||
---
|
||||
|
||||
## Agent Integration
|
||||
|
||||
### Shared Context
|
||||
|
||||
- References: `_bmad/saga/context.md`, `_bmad/saga/architecture.md`
|
||||
- Collaboration with: Thor (The Builder)
|
||||
|
||||
### Workflow References
|
||||
|
||||
- `scan-project/workflow.md`
|
||||
- `update-saga/workflow.md`
|
||||
|
||||
---
|
||||
|
||||
## Implementation Notes
|
||||
|
||||
**Use the create-agent workflow to build this agent.**
|
||||
|
||||
---
|
||||
|
||||
_Spec created on 2026-01-27 via BMAD Module workflow_
|
||||
|
|
@ -0,0 +1,79 @@
|
|||
# Agent Specification: thor
|
||||
|
||||
**Module:** rmtn-solo-dev
|
||||
**Status:** Placeholder — To be created via create-agent workflow
|
||||
**Created:** 2026-01-27
|
||||
|
||||
---
|
||||
|
||||
## Agent Metadata
|
||||
|
||||
```yaml
|
||||
agent:
|
||||
metadata:
|
||||
id: "_bmad/rmtn-solo-dev/agents/thor.md"
|
||||
name: The Builder
|
||||
title: Implementation Lead
|
||||
icon: 🔨
|
||||
module: rmtn-solo-dev
|
||||
hasSidecar: false
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Agent Persona
|
||||
|
||||
### Role
|
||||
|
||||
Implementation, Execution. Plans Quests, scores approaches, writes Tech Specs, writes code.
|
||||
|
||||
### Identity
|
||||
|
||||
Thor, the Builder. The force of action and execution.
|
||||
|
||||
### Communication Style
|
||||
|
||||
Action-oriented, strong, reliable. Direct and powerful ("The hammer is ready", "Approach A is the direct strike").
|
||||
|
||||
### Principles
|
||||
|
||||
- Plan before striking (measure twice, cut once).
|
||||
- Validate every step.
|
||||
- Speed through discipline, not shortcuts.
|
||||
|
||||
---
|
||||
|
||||
## Agent Menu
|
||||
|
||||
### Planned Commands
|
||||
|
||||
| Trigger | Command | Description | Workflow |
|
||||
|---------|---------|-------------|----------|
|
||||
| [NQ] | New Quest | Plans a new feature (Approach scoring + Tech Spec) | new-quest |
|
||||
| [EX] | Execute Quest | Implements a planned Quest step-by-step | execute-quest |
|
||||
| [QF] | Quick Fix | Rapidly fixes bugs without full Quest ceremony | quick-fix |
|
||||
|
||||
---
|
||||
|
||||
## Agent Integration
|
||||
|
||||
### Shared Context
|
||||
|
||||
- References: `_bmad/saga/context.md`, `_bmad/saga/architecture.md`, `quests/*.md`
|
||||
- Collaboration with: Mimir (The Sage)
|
||||
|
||||
### Workflow References
|
||||
|
||||
- `new-quest/workflow.md`
|
||||
- `execute-quest/workflow.md`
|
||||
- `quick-fix/workflow.md`
|
||||
|
||||
---
|
||||
|
||||
## Implementation Notes
|
||||
|
||||
**Use the create-agent workflow to build this agent.**
|
||||
|
||||
---
|
||||
|
||||
_Spec created on 2026-01-27 via BMAD Module workflow_
|
||||
|
|
@ -0,0 +1,55 @@
|
|||
# Agents Reference
|
||||
|
||||
rmtn-solo-dev includes 2 specialized agents:
|
||||
|
||||
---
|
||||
|
||||
## Mimir (The Sage)
|
||||
|
||||
**ID:** `_bmad/rmtn-solo-dev/agents/mimir.md`
|
||||
**Icon:** 📜
|
||||
|
||||
**Role:**
|
||||
Context Keeper, Analyst. Scans codebase, maintains "Saga" (PRD/Arch), ensures consistency. Wise, observant.
|
||||
|
||||
**When to Use:**
|
||||
- When you need to generate initial project documentation.
|
||||
- When you need to update the Saga after completing features.
|
||||
- When you need "wisdom" or high-level context analysis.
|
||||
|
||||
**Key Capabilities:**
|
||||
- Codebase scanning
|
||||
- Documentation generation (PRD, Architecture)
|
||||
- Context maintenance
|
||||
|
||||
**Menu Trigger(s):**
|
||||
- `[SC]` Scan Project
|
||||
- `[US]` Update Saga
|
||||
|
||||
---
|
||||
|
||||
## Thor (The Builder)
|
||||
|
||||
**ID:** `_bmad/rmtn-solo-dev/agents/thor.md`
|
||||
**Icon:** 🔨
|
||||
|
||||
**Role:**
|
||||
Implementation, Execution. Plans Quests, scores approaches, writes Tech Specs, writes code. Direct, powerful.
|
||||
|
||||
**When to Use:**
|
||||
- When you want to build a new feature (Quest).
|
||||
- When you need to execute a plan.
|
||||
- When you need a quick bug fix.
|
||||
|
||||
**Key Capabilities:**
|
||||
- Feature planning (Approach scoring)
|
||||
- Technical Specification writing
|
||||
- Code implementation
|
||||
- Validation
|
||||
|
||||
**Menu Trigger(s):**
|
||||
- `[NQ]` New Quest
|
||||
- `[EX]` Execute Quest
|
||||
- `[QF]` Quick Fix
|
||||
|
||||
---
|
||||
|
|
@ -0,0 +1,60 @@
|
|||
# Examples & Use Cases
|
||||
|
||||
This section provides practical examples for using RMTN Developer Suite.
|
||||
|
||||
---
|
||||
|
||||
## Example Workflows
|
||||
|
||||
### Scenario 1: The New Feature (The Quest)
|
||||
|
||||
1. **User:** "Thor, I need to add user authentication."
|
||||
2. **Thor (New Quest):** Reads Saga. Proposes 3 approaches:
|
||||
* A: Simple Email/Pass (Low Risk, Med Impact)
|
||||
* B: OAuth via Provider (Med Risk, High Impact)
|
||||
* C: Complex RBAC (High Risk, High Impact)
|
||||
3. **User:** Selects B.
|
||||
4. **Thor:** Drafts `quests/quest-001-auth.md` with detailed steps.
|
||||
5. **User:** "Looks good."
|
||||
6. **Thor (Execute Quest):** Implements Step 1 (Install SDK), Step 2 (Config), etc., validating each step.
|
||||
7. **User:** "Done."
|
||||
8. **Mimir (Update Saga):** Updates `context.md` to reflect new Auth system.
|
||||
|
||||
### Scenario 2: The Quick Fix
|
||||
|
||||
1. **User:** "Thor, there's a typo in the login button label."
|
||||
2. **Thor (Quick Fix):** "On it. Identifying file..." finds `Login.tsx`.
|
||||
3. **Thor:** Fixes typo. "Fixed. Verify?"
|
||||
4. **User:** "Good."
|
||||
|
||||
---
|
||||
|
||||
## Common Scenarios
|
||||
|
||||
- **Genesis:** Use Mimir to "boot up" the project context so you don't have to explain the stack repeatedly.
|
||||
- **The Weekend Project:** Use Thor to quickly spec out and build a prototype without getting bogged down in docs, but keeping enough structure to pick it up next weekend.
|
||||
|
||||
---
|
||||
|
||||
## Tips & Tricks
|
||||
|
||||
- **Trust the Saga:** Let Mimir handle the memory. If Mimir knows it, Thor knows it.
|
||||
- **Score Your Approaches:** Thor's scoring system is great for making you think about *Risk* vs *Reward* before coding.
|
||||
- **Commit Often:** Execute Quest works best when you commit after each step.
|
||||
|
||||
---
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### Common Issues
|
||||
|
||||
- **Saga out of date:** Run `[US] Update Saga` manually if you feel the context is drifting.
|
||||
- **Quest stuck:** If execution fails, you can manually edit the Quest markdown file to adjust the plan.
|
||||
|
||||
---
|
||||
|
||||
## Getting More Help
|
||||
|
||||
- Review the main BMAD documentation
|
||||
- Check module configuration in module.yaml
|
||||
- Verify all agents and workflows are properly installed
|
||||
|
|
@ -0,0 +1,71 @@
|
|||
# Getting Started with RMTN Developer Suite
|
||||
|
||||
Welcome to rmtn-solo-dev! This guide will help you get up and running.
|
||||
|
||||
---
|
||||
|
||||
## What This Module Does
|
||||
|
||||
**RMTN Developer Suite** is a "Senior Developer in a Box" that automates context-keeping and planning overhead, allowing a solo developer to move with the speed and quality of a full team.
|
||||
|
||||
It enforces a "Plan → Execute" discipline with automated context management via two specialized agents:
|
||||
- **Mimir (The Sage):** Handles context and documentation (Saga).
|
||||
- **Thor (The Builder):** Handles planning and execution (Quests).
|
||||
|
||||
---
|
||||
|
||||
## Installation
|
||||
|
||||
If you haven't installed the module yet:
|
||||
|
||||
```bash
|
||||
bmad install rmtn-solo-dev
|
||||
```
|
||||
|
||||
Follow the prompts to configure the module for your needs. You will be asked where to store your Saga (context) and Quests.
|
||||
|
||||
---
|
||||
|
||||
## First Steps
|
||||
|
||||
1. **Genesis (Onboarding):**
|
||||
- Trigger Mimir with `[SC] Scan Project`.
|
||||
- Provide a description of your project.
|
||||
- Mimir will scan your codebase and generate the **Saga** (`context.md` and `architecture.md`).
|
||||
- Review and approve these documents. They are now the "Source of Truth".
|
||||
|
||||
2. **The Quest (Feature Work):**
|
||||
- Trigger Thor with `[NQ] New Quest`.
|
||||
- Describe the feature you want to build.
|
||||
- Thor will read the Saga, propose 3 approaches, and score them.
|
||||
- Once you select an approach, Thor drafts a **Tech Spec** (Quest file).
|
||||
|
||||
3. **Execution:**
|
||||
- Trigger Thor with `[EX] Execute Quest`.
|
||||
- Point him to the created Quest file.
|
||||
- Thor implements the changes step-by-step.
|
||||
|
||||
---
|
||||
|
||||
## Common Use Cases
|
||||
|
||||
- **Daily Feature Work:** Using the Quest system to build complex features with high quality.
|
||||
- **Bug Fixing:** Using `[QF] Quick Fix` for rapid patches without overhead.
|
||||
- **Project Onboarding:** Using `[SC] Scan Project` to quickly generate documentation for a new or existing codebase.
|
||||
|
||||
---
|
||||
|
||||
## What's Next?
|
||||
|
||||
- Check out the [Agents Reference](agents.md) to meet your team
|
||||
- Browse the [Workflows Reference](workflows.md) to see what you can do
|
||||
- See [Examples](examples.md) for real-world usage
|
||||
|
||||
---
|
||||
|
||||
## Need Help?
|
||||
|
||||
If you run into issues:
|
||||
1. Check the troubleshooting section in examples.md
|
||||
2. Review your module configuration
|
||||
3. Consult the broader BMAD documentation
|
||||
|
|
@ -0,0 +1,118 @@
|
|||
# Workflows Reference
|
||||
|
||||
rmtn-solo-dev includes 5 workflows:
|
||||
|
||||
---
|
||||
|
||||
## Scan Project
|
||||
|
||||
**ID:** `scan-project`
|
||||
**Workflow:** `scan-project`
|
||||
|
||||
**Purpose:**
|
||||
Scan codebase to generate Saga (PRD/Arch).
|
||||
|
||||
**When to Use:**
|
||||
At the beginning of a project or when onboarding the module to an existing project.
|
||||
|
||||
**Key Steps:**
|
||||
1. Welcome & Input
|
||||
2. Scan Codebase
|
||||
3. Analyze & Draft
|
||||
4. Review
|
||||
5. Finalize
|
||||
|
||||
**Agent(s):**
|
||||
Mimir
|
||||
|
||||
---
|
||||
|
||||
## New Quest
|
||||
|
||||
**ID:** `new-quest`
|
||||
**Workflow:** `new-quest`
|
||||
|
||||
**Purpose:**
|
||||
Plan a new feature (Approach scoring + Tech Spec).
|
||||
|
||||
**When to Use:**
|
||||
When starting any significant feature or refactor.
|
||||
|
||||
**Key Steps:**
|
||||
1. Briefing
|
||||
2. Strategize (3 Approaches)
|
||||
3. Select & Plan
|
||||
4. Review
|
||||
5. Create Quest
|
||||
|
||||
**Agent(s):**
|
||||
Thor (Primary), Mimir (Context)
|
||||
|
||||
---
|
||||
|
||||
## Execute Quest
|
||||
|
||||
**ID:** `execute-quest`
|
||||
**Workflow:** `execute-quest`
|
||||
|
||||
**Purpose:**
|
||||
Implement a planned Quest step-by-step.
|
||||
|
||||
**When to Use:**
|
||||
After a Quest has been planned and approved.
|
||||
|
||||
**Key Steps:**
|
||||
1. Load Quest
|
||||
2. Select Step
|
||||
3. Implement
|
||||
4. Validate
|
||||
5. Update Status
|
||||
|
||||
**Agent(s):**
|
||||
Thor
|
||||
|
||||
---
|
||||
|
||||
## Update Saga
|
||||
|
||||
**ID:** `update-saga`
|
||||
**Workflow:** `update-saga`
|
||||
|
||||
**Purpose:**
|
||||
Update Saga based on completed Quests.
|
||||
|
||||
**When to Use:**
|
||||
After completing a Quest or a set of Quests to ensure documentation stays in sync.
|
||||
|
||||
**Key Steps:**
|
||||
1. Load Context
|
||||
2. Analyze Changes
|
||||
3. Draft Updates
|
||||
4. Review
|
||||
5. Commit
|
||||
|
||||
**Agent(s):**
|
||||
Mimir
|
||||
|
||||
---
|
||||
|
||||
## Quick Fix
|
||||
|
||||
**ID:** `quick-fix`
|
||||
**Workflow:** `quick-fix`
|
||||
|
||||
**Purpose:**
|
||||
Rapidly fix bugs without full Quest ceremony.
|
||||
|
||||
**When to Use:**
|
||||
For minor bugs, typos, or small tasks that don't require architectural planning.
|
||||
|
||||
**Key Steps:**
|
||||
1. Identify
|
||||
2. Implement
|
||||
3. Verify
|
||||
|
||||
**Agent(s):**
|
||||
Thor
|
||||
|
||||
---
|
||||
|
|
@ -0,0 +1,16 @@
|
|||
code: rmtn-solo-dev
|
||||
name: "RMTN Developer Suite"
|
||||
header: "A 'Senior Developer in a Box' for elite solo developers."
|
||||
subheader: "Automates context management and enforces a 'Plan -> Execute' workflow."
|
||||
default_selected: false
|
||||
|
||||
# Custom Configuration Variables
|
||||
saga_folder:
|
||||
prompt: "Where should the Saga (Context/Arch) be stored?"
|
||||
default: "_bmad/saga"
|
||||
result: "{project-root}/{value}"
|
||||
|
||||
quests_folder:
|
||||
prompt: "Where should Quests be stored?"
|
||||
default: "quests"
|
||||
result: "{project-root}/{value}"
|
||||
|
|
@ -0,0 +1,95 @@
|
|||
# Workflow Specification: execute-quest
|
||||
|
||||
**Module:** rmtn-solo-dev
|
||||
**Status:** Placeholder — To be created via create-workflow workflow
|
||||
**Created:** 2026-01-27
|
||||
|
||||
---
|
||||
|
||||
## Workflow Overview
|
||||
|
||||
**Goal:** Implement a planned Quest step-by-step.
|
||||
|
||||
**Description:** Thor takes an approved Quest/Tech Spec and implements it, updating the status as he goes.
|
||||
|
||||
**Workflow Type:** Core
|
||||
|
||||
---
|
||||
|
||||
## Workflow Structure
|
||||
|
||||
### Entry Point
|
||||
|
||||
```yaml
|
||||
---
|
||||
name: execute-quest
|
||||
description: Implement a planned Quest step-by-step
|
||||
web_bundle: true
|
||||
installed_path: '{project-root}/_bmad/rmtn-solo-dev/workflows/execute-quest'
|
||||
---
|
||||
```
|
||||
|
||||
### Mode
|
||||
|
||||
- [ ] Create-only (steps-c/)
|
||||
- [x] Tri-modal (steps-c/, steps-e/, steps-v/) (Execute is effectively editing/updating the quest)
|
||||
|
||||
---
|
||||
|
||||
## Planned Steps
|
||||
|
||||
| Step | Name | Goal |
|
||||
|------|------|------|
|
||||
| 1 | Load Quest | Read the Quest/Tech Spec |
|
||||
| 2 | Select Step | Determine next step to implement |
|
||||
| 3 | Implement | Write code for the step |
|
||||
| 4 | Validate | Verify changes (lint/test) |
|
||||
| 5 | Update Status | Mark step complete in Quest file |
|
||||
|
||||
---
|
||||
|
||||
## Workflow Inputs
|
||||
|
||||
### Required Inputs
|
||||
|
||||
- Quest file (`quests/quest-XXX.md`)
|
||||
|
||||
### Optional Inputs
|
||||
|
||||
- User feedback during execution
|
||||
|
||||
---
|
||||
|
||||
## Workflow Outputs
|
||||
|
||||
### Output Format
|
||||
|
||||
- [ ] Document-producing
|
||||
- [x] Non-document (Code changes + Status updates)
|
||||
|
||||
### Output Files
|
||||
|
||||
- Updated codebase
|
||||
- Updated `quests/quest-XXX.md`
|
||||
|
||||
---
|
||||
|
||||
## Agent Integration
|
||||
|
||||
### Primary Agent
|
||||
|
||||
Thor
|
||||
|
||||
### Other Agents
|
||||
|
||||
None
|
||||
|
||||
---
|
||||
|
||||
## Implementation Notes
|
||||
|
||||
**Use the create-workflow workflow to build this workflow.**
|
||||
|
||||
---
|
||||
|
||||
_Spec created on 2026-01-27 via BMAD Module workflow_
|
||||
|
|
@ -0,0 +1,95 @@
|
|||
# Workflow Specification: new-quest
|
||||
|
||||
**Module:** rmtn-solo-dev
|
||||
**Status:** Placeholder — To be created via create-workflow workflow
|
||||
**Created:** 2026-01-27
|
||||
|
||||
---
|
||||
|
||||
## Workflow Overview
|
||||
|
||||
**Goal:** Plan a new feature (Approach scoring + Tech Spec).
|
||||
|
||||
**Description:** Thor reads the Saga and user request, brainstorms 3 approaches, scores them (Risk/Impact/Ease), selects the best one, and drafts a detailed Tech Spec.
|
||||
|
||||
**Workflow Type:** Core
|
||||
|
||||
---
|
||||
|
||||
## Workflow Structure
|
||||
|
||||
### Entry Point
|
||||
|
||||
```yaml
|
||||
---
|
||||
name: new-quest
|
||||
description: Plan a new feature (Approach scoring + Tech Spec)
|
||||
web_bundle: true
|
||||
installed_path: '{project-root}/_bmad/rmtn-solo-dev/workflows/new-quest'
|
||||
---
|
||||
```
|
||||
|
||||
### Mode
|
||||
|
||||
- [x] Create-only (steps-c/)
|
||||
- [ ] Tri-modal (steps-c/, steps-e/, steps-v/)
|
||||
|
||||
---
|
||||
|
||||
## Planned Steps
|
||||
|
||||
| Step | Name | Goal |
|
||||
|------|------|------|
|
||||
| 1 | Briefing | Get user request and read Saga |
|
||||
| 2 | Strategize | Brainstorm 3 approaches and score them |
|
||||
| 3 | Select & Plan | Select best approach and draft Tech Spec |
|
||||
| 4 | Review | User reviews Tech Spec |
|
||||
| 5 | Create Quest | Write Quest file to quests/ folder |
|
||||
|
||||
---
|
||||
|
||||
## Workflow Inputs
|
||||
|
||||
### Required Inputs
|
||||
|
||||
- User Request
|
||||
- Saga (`context.md`, `architecture.md`)
|
||||
|
||||
### Optional Inputs
|
||||
|
||||
- Specific file references
|
||||
|
||||
---
|
||||
|
||||
## Workflow Outputs
|
||||
|
||||
### Output Format
|
||||
|
||||
- [x] Document-producing
|
||||
- [ ] Non-document
|
||||
|
||||
### Output Files
|
||||
|
||||
- `quests/quest-{id}-{name}.md`
|
||||
|
||||
---
|
||||
|
||||
## Agent Integration
|
||||
|
||||
### Primary Agent
|
||||
|
||||
Thor
|
||||
|
||||
### Other Agents
|
||||
|
||||
Mimir (Context provider via Saga)
|
||||
|
||||
---
|
||||
|
||||
## Implementation Notes
|
||||
|
||||
**Use the create-workflow workflow to build this workflow.**
|
||||
|
||||
---
|
||||
|
||||
_Spec created on 2026-01-27 via BMAD Module workflow_
|
||||
|
|
@ -0,0 +1,92 @@
|
|||
# Workflow Specification: quick-fix
|
||||
|
||||
**Module:** rmtn-solo-dev
|
||||
**Status:** Placeholder — To be created via create-workflow workflow
|
||||
**Created:** 2026-01-27
|
||||
|
||||
---
|
||||
|
||||
## Workflow Overview
|
||||
|
||||
**Goal:** Rapidly fix bugs without full Quest ceremony.
|
||||
|
||||
**Description:** Thor identifies the file, fixes the issue, and confirms, skipping the detailed planning phase.
|
||||
|
||||
**Workflow Type:** Utility
|
||||
|
||||
---
|
||||
|
||||
## Workflow Structure
|
||||
|
||||
### Entry Point
|
||||
|
||||
```yaml
|
||||
---
|
||||
name: quick-fix
|
||||
description: Rapidly fix bugs without full Quest ceremony
|
||||
web_bundle: true
|
||||
installed_path: '{project-root}/_bmad/rmtn-solo-dev/workflows/quick-fix'
|
||||
---
|
||||
```
|
||||
|
||||
### Mode
|
||||
|
||||
- [x] Create-only (steps-c/)
|
||||
- [ ] Tri-modal (steps-c/, steps-e/, steps-v/)
|
||||
|
||||
---
|
||||
|
||||
## Planned Steps
|
||||
|
||||
| Step | Name | Goal |
|
||||
|------|------|------|
|
||||
| 1 | Identify | User describes bug/task, Thor finds file |
|
||||
| 2 | Implement | Thor applies fix |
|
||||
| 3 | Verify | User confirms fix |
|
||||
|
||||
---
|
||||
|
||||
## Workflow Inputs
|
||||
|
||||
### Required Inputs
|
||||
|
||||
- Bug description / Task
|
||||
|
||||
### Optional Inputs
|
||||
|
||||
- File path (if known)
|
||||
|
||||
---
|
||||
|
||||
## Workflow Outputs
|
||||
|
||||
### Output Format
|
||||
|
||||
- [ ] Document-producing
|
||||
- [x] Non-document (Code changes)
|
||||
|
||||
### Output Files
|
||||
|
||||
- Updated codebase
|
||||
|
||||
---
|
||||
|
||||
## Agent Integration
|
||||
|
||||
### Primary Agent
|
||||
|
||||
Thor
|
||||
|
||||
### Other Agents
|
||||
|
||||
None
|
||||
|
||||
---
|
||||
|
||||
## Implementation Notes
|
||||
|
||||
**Use the create-workflow workflow to build this workflow.**
|
||||
|
||||
---
|
||||
|
||||
_Spec created on 2026-01-27 via BMAD Module workflow_
|
||||
|
|
@ -0,0 +1,96 @@
|
|||
# Workflow Specification: scan-project
|
||||
|
||||
**Module:** rmtn-solo-dev
|
||||
**Status:** Placeholder — To be created via create-workflow workflow
|
||||
**Created:** 2026-01-27
|
||||
|
||||
---
|
||||
|
||||
## Workflow Overview
|
||||
|
||||
**Goal:** Scan codebase to generate Saga (PRD/Arch).
|
||||
|
||||
**Description:** Mimir analyzes the codebase and user description to generate the `context.md` (PRD) and `architecture.md` files, establishing the source of truth for the project.
|
||||
|
||||
**Workflow Type:** Core
|
||||
|
||||
---
|
||||
|
||||
## Workflow Structure
|
||||
|
||||
### Entry Point
|
||||
|
||||
```yaml
|
||||
---
|
||||
name: scan-project
|
||||
description: Scan codebase to generate Saga (PRD/Arch)
|
||||
web_bundle: true
|
||||
installed_path: '{project-root}/_bmad/rmtn-solo-dev/workflows/scan-project'
|
||||
---
|
||||
```
|
||||
|
||||
### Mode
|
||||
|
||||
- [x] Create-only (steps-c/)
|
||||
- [ ] Tri-modal (steps-c/, steps-e/, steps-v/)
|
||||
|
||||
---
|
||||
|
||||
## Planned Steps
|
||||
|
||||
| Step | Name | Goal |
|
||||
|------|------|------|
|
||||
| 1 | Welcome & Input | Get user description of the project |
|
||||
| 2 | Scan Codebase | Use tools to list files and read key files |
|
||||
| 3 | Analyze & Draft | Draft context.md and architecture.md |
|
||||
| 4 | Review | Present drafts to user for approval |
|
||||
| 5 | Finalize | Write files to Saga folder |
|
||||
|
||||
---
|
||||
|
||||
## Workflow Inputs
|
||||
|
||||
### Required Inputs
|
||||
|
||||
- Codebase (file system access)
|
||||
- User description/intent
|
||||
|
||||
### Optional Inputs
|
||||
|
||||
- Existing documentation
|
||||
|
||||
---
|
||||
|
||||
## Workflow Outputs
|
||||
|
||||
### Output Format
|
||||
|
||||
- [x] Document-producing
|
||||
- [ ] Non-document
|
||||
|
||||
### Output Files
|
||||
|
||||
- `_bmad/saga/context.md`
|
||||
- `_bmad/saga/architecture.md`
|
||||
|
||||
---
|
||||
|
||||
## Agent Integration
|
||||
|
||||
### Primary Agent
|
||||
|
||||
Mimir
|
||||
|
||||
### Other Agents
|
||||
|
||||
None
|
||||
|
||||
---
|
||||
|
||||
## Implementation Notes
|
||||
|
||||
**Use the create-workflow workflow to build this workflow.**
|
||||
|
||||
---
|
||||
|
||||
_Spec created on 2026-01-27 via BMAD Module workflow_
|
||||
|
|
@ -0,0 +1,96 @@
|
|||
# Workflow Specification: update-saga
|
||||
|
||||
**Module:** rmtn-solo-dev
|
||||
**Status:** Placeholder — To be created via create-workflow workflow
|
||||
**Created:** 2026-01-27
|
||||
|
||||
---
|
||||
|
||||
## Workflow Overview
|
||||
|
||||
**Goal:** Update Saga based on completed Quests.
|
||||
|
||||
**Description:** Mimir analyzes completed Quests and code changes to update the `context.md` and `architecture.md` files, ensuring the Saga remains current.
|
||||
|
||||
**Workflow Type:** Feature
|
||||
|
||||
---
|
||||
|
||||
## Workflow Structure
|
||||
|
||||
### Entry Point
|
||||
|
||||
```yaml
|
||||
---
|
||||
name: update-saga
|
||||
description: Update Saga based on completed Quests
|
||||
web_bundle: true
|
||||
installed_path: '{project-root}/_bmad/rmtn-solo-dev/workflows/update-saga'
|
||||
---
|
||||
```
|
||||
|
||||
### Mode
|
||||
|
||||
- [ ] Create-only (steps-c/)
|
||||
- [x] Tri-modal (steps-c/, steps-e/, steps-v/) (Updating existing docs)
|
||||
|
||||
---
|
||||
|
||||
## Planned Steps
|
||||
|
||||
| Step | Name | Goal |
|
||||
|------|------|------|
|
||||
| 1 | Load Context | Read current Saga and completed Quest(s) |
|
||||
| 2 | Analyze Changes | Determine impact on PRD/Arch |
|
||||
| 3 | Draft Updates | Propose changes to Saga files |
|
||||
| 4 | Review | User confirms updates |
|
||||
| 5 | Commit | Write updated Saga files |
|
||||
|
||||
---
|
||||
|
||||
## Workflow Inputs
|
||||
|
||||
### Required Inputs
|
||||
|
||||
- Completed Quest(s)
|
||||
- Current Saga
|
||||
|
||||
### Optional Inputs
|
||||
|
||||
- User notes
|
||||
|
||||
---
|
||||
|
||||
## Workflow Outputs
|
||||
|
||||
### Output Format
|
||||
|
||||
- [x] Document-producing
|
||||
- [ ] Non-document
|
||||
|
||||
### Output Files
|
||||
|
||||
- Updated `_bmad/saga/context.md`
|
||||
- Updated `_bmad/saga/architecture.md`
|
||||
|
||||
---
|
||||
|
||||
## Agent Integration
|
||||
|
||||
### Primary Agent
|
||||
|
||||
Mimir
|
||||
|
||||
### Other Agents
|
||||
|
||||
None
|
||||
|
||||
---
|
||||
|
||||
## Implementation Notes
|
||||
|
||||
**Use the create-workflow workflow to build this workflow.**
|
||||
|
||||
---
|
||||
|
||||
_Spec created on 2026-01-27 via BMAD Module workflow_
|
||||
Loading…
Reference in New Issue