120 lines
3.6 KiB
Markdown
120 lines
3.6 KiB
Markdown
# NEXT-METHOD™ Documentation
|
|
|
|
Welcome to the NEXT-METHOD documentation folder! This directory contains all the documentation, guides, and resources for NEXT-METHOD - the intelligent wrapper around BMAD-METHOD that provides an iterative, guided development experience.
|
|
|
|
## 📚 Documentation Files
|
|
|
|
### Core Documentation
|
|
- **[next-method-documentation.md](./next-method-documentation.md)** - Complete user guide and reference
|
|
- **[next-method-implementation.md](./next-method-implementation.md)** - Technical implementation summary
|
|
|
|
### Tools and Examples
|
|
- **[demo-next-workflow.sh](./demo-next-workflow.sh)** - Demonstration script showing the iterative workflow
|
|
|
|
## 🚀 Quick Start
|
|
|
|
1. **Read the Overview**: Start with [next-method-documentation.md](./next-method-documentation.md)
|
|
2. **Try the Demo**: Run `./demo-next-workflow.sh` to see the workflow in action
|
|
3. **Check Implementation**: Review [next-method-implementation.md](./next-method-implementation.md) for technical details
|
|
|
|
## 🎯 What is NEXT-METHOD?
|
|
|
|
NEXT-METHOD transforms BMAD-METHOD from a manual command-selection tool into an intelligent, guided development assistant. Instead of manually choosing which tasks or commands to run, you simply type `next` repeatedly, and the system intelligently suggests and executes the next appropriate step.
|
|
|
|
### Key Benefits
|
|
- **Reduced Cognitive Load** - No need to remember what to do next
|
|
- **Guided Development** - System suggests logical next steps
|
|
- **Context Awareness** - Remembers progress and adapts suggestions
|
|
- **Faster Workflow** - Less time deciding, more time doing
|
|
- **Full BMAD Access** - All existing features preserved
|
|
|
|
## 🔄 The "Next" Workflow
|
|
|
|
```bash
|
|
# Start the process
|
|
next
|
|
|
|
# Continue with next suggestion
|
|
next
|
|
|
|
# Keep going...
|
|
next
|
|
|
|
# See all options
|
|
next --suggest
|
|
|
|
# Auto-execute next step
|
|
next --auto
|
|
```
|
|
|
|
## 📖 Documentation Structure
|
|
|
|
### User Guide
|
|
The [next-method-documentation.md](./next-method-documentation.md) file contains:
|
|
- Complete command reference
|
|
- Workflow phase explanations
|
|
- Usage examples and best practices
|
|
- Configuration options
|
|
- Troubleshooting guide
|
|
- API reference for developers
|
|
|
|
### Implementation Details
|
|
The [next-method-implementation.md](./next-method-implementation.md) file covers:
|
|
- What was implemented
|
|
- Technical architecture
|
|
- File structure changes
|
|
- Success criteria verification
|
|
- Future enhancement possibilities
|
|
|
|
### Demo and Examples
|
|
The [demo-next-workflow.sh](./demo-next-workflow.sh) script demonstrates:
|
|
- How the iterative workflow works
|
|
- Expected outputs for each step
|
|
- Key benefits and features
|
|
- Integration with BMAD-METHOD
|
|
|
|
## 🔗 Related Resources
|
|
|
|
- **Main README**: [../README.md](../README.md) - Project overview and quick start
|
|
- **BMAD-METHOD Core**: [../core-architecture.md](../core-architecture.md) - Technical architecture
|
|
- **User Guide**: [../user-guide.md](../user-guide.md) - BMAD-METHOD user guide
|
|
- **Expansion Packs**: [../expansion-packs.md](../expansion-packs.md) - Available extensions
|
|
|
|
## 🚀 Getting Started
|
|
|
|
1. **Install NEXT-METHOD**:
|
|
```bash
|
|
npm install -g next-method
|
|
```
|
|
|
|
2. **Navigate to your project**:
|
|
```bash
|
|
cd your-project
|
|
```
|
|
|
|
3. **Start the iterative process**:
|
|
```bash
|
|
next
|
|
```
|
|
|
|
4. **Keep going**:
|
|
```bash
|
|
next
|
|
next
|
|
next
|
|
```
|
|
|
|
## 🤝 Contributing
|
|
|
|
We welcome contributions to NEXT-METHOD! Please see the main [CONTRIBUTING.md](../CONTRIBUTING.md) file for guidelines.
|
|
|
|
## 📄 License
|
|
|
|
This project is licensed under the MIT License - see the [LICENSE](../LICENSE) file for details.
|
|
|
|
---
|
|
|
|
**NEXT-METHOD™** - Making AI-driven development as simple as typing "next" repeatedly! 🚀
|
|
|
|
*Built with ❤️ for the AI-assisted development community*
|