ZNS-METHOD Framework

Zero-to-Null-State Method - Business Modeling & Application Development Framework based on BMAD-METHOD V6+

🌟 Características Principales

ZNS-METHOD is a modular agentic framework for software modernization, development, and migration. Built on top of BMAD-METHOD V6+, it provides specialized agents and workflows for:

• 🎯 Product Planning (requirements, user stories, backlog management)
• 🔍 Technical Audits (frontend/backend code analysis)
• 🏗️ Architecture Design (data modeling, system design)
• 💻 Multi-Stack Development (.NET, Java, Python, PHP, React, React Native)
• 🔄 Legacy Migration (obsolescence analysis, modernization planning)
• 📊 Cost Estimation & Validation (effort estimation, quality assurance)

🎯 Key Features

✅ V6+ Compliance

• Agent Schema: Full metadata + persona (role, identity, communication_style, principles)
• Menu System: Handlebars-based workflow triggers with {project-root}, {bmad_folder}, {output_folder}
• Customization: .customize.yaml overlay system for persistent agent personalization
• Party Mode: Multi-agent collaborative workflows
• Phase System: Phase 0-4 (Documentation → Analysis → Planning → Solutioning → Implementation)
• Scale-Adaptive: Level 0-4 complexity adjustment

🛠️ CLI System

# Install ZNS Method
npx znsmtd install

# Compile agents (YAML → XML)
npx znsmtd compile --all

# Check installation status
npx znsmtd status

# Install custom agent
npx znsmtd agent-install path/to/custom-agent.yaml

# Validate agent schemas
npx znsmtd validate

# Update to latest version
npx znsmtd update

📦 Modular Architecture

bmad-method/
├── src/
│   ├── cli/                     # CLI commands entry point
│   ├── core/
│   │   └── scale-adaptive/      # Level detector & workflow selector
│   ├── modules/                 # Specialized agent modules
│   │   ├── zns-core/            # Core: Product Owner, Data Modeling, Architecture
│   │   ├── zns-audit/           # Frontend/Backend audits
│   │   ├── zns-development/     # Language-specific developers
│   │   ├── zns-devops/          # DevSecOps workflows
│   │   ├── zns-migration/       # Legacy modernization
│   │   ├── zns-utilities/       # C4 diagrams, cost estimation
│   │   └── zns-validation/      # Quality assurance
│   ├── shared/                  # Shared resources
│   │   └── templates/           # Business templates
│   └── utility/                 # Utility functions (planned)
├── testarch/                    # Testing infrastructure
│   ├── schemas/                 # JSON Schema (agent-v6, workflow)
│   ├── validators/              # Schema & semantic validators
│   ├── tests/                   # 75 tests (unit + integration)
│   ├── run-validation-suite.js  # Validation suite runner
│   └── package.json             # Test dependencies
├── tools/                       # Build & compilation tools
│   ├── compiler/                # YAML→XML agent compiler (scaffold)
│   ├── cli/                     # CLI implementation (scaffold)
│   ├── validators/              # Legacy validators
│   └── znsmtd-npx-wrapper.js    # NPX wrapper
├── docs/                        # Complete documentation
│   ├── api/                     # API documentation (1,200+ lines)
│   ├── tutorials/               # Getting started, agent development (1,400+ lines)
│   └── BMAD-METHOD-main/        # BMAD V6+ reference
├── .github/workflows/           # CI/CD (GitHub Actions)
├── .bmad-config.yaml            # Project configuration
├── package.json                 # @bmad-method/framework v6.0.0
├── README.md                    # This file
├── CHANGELOG.md                 # Version history
├── CONTRIBUTING.md              # Contribution guidelines
└── LICENSE                      # MIT License

🚀 Quick Start

Installation

# Install globally via NPM
npm install -g @znsmtd/framework

# Or use directly via npx
npx @znsmtd/framework install
# or
npx znsmtd install

Interactive Setup

npx znsmtd install

This will:

1. Prompt you to select modules (zns-core, zns-audit, zns-development, etc.)
2. Create .znsmtd/ directory with selected modules
3. Generate config.yaml with installation settings
4. Copy agent files from src/ to .znsmtd/
5. Compile agents (YAML → XML)

Running Your First Workflow

# 1. Check status
npx znsmtd status

# 2. Compile agents
npx znsmtd compile --all

# 3. Start a workflow (from your IDE or CLI)
# Open .znsmtd/zns-core/agents/product-owner.xml in VS Code
# Trigger menu option: "create-user-stories"

📦 Modules

🎯 zns-core (Required)

Core methodology agents and workflows

Agents:

• product-owner.agent.yaml - User stories, backlog, requirements
• data-modeling.agent.yaml - Entity relationships, database design
• definition-of-architecture.agent.yaml - System architecture, technology stack
• consolidation-context.agent.yaml - Context gathering, requirements extraction

Workflows:

• context-consolidation/ - Gather and organize business context
• requirements-extraction/ - Extract functional/non-functional requirements
• user-story-creation/ - Create INVEST user stories
• data-modeling/ - Design data models and ERD
• architecture-definition/ - Define system architecture

🔍 zns-audit (Optional)

Technical audit agents for frontend and backend

Agents:

• frontend-audit.agent.yaml - React, Angular, Vue audits
• backend-audit.agent.yaml - .NET, Java, Python audits

Workflows:

• frontend-audit-complete/ - Complete frontend codebase audit
• backend-audit-complete/ - Complete backend codebase audit

💻 zns-development (Optional)

Language-specific senior developer agents

Agents:

• dotnet-core-senior-developer.agent.yaml - ASP.NET Core development
• backend-senior-java-developer.agent.yaml - Java Spring Boot development
• python-senior-developer.agent.yaml - Python Django/Flask development
• php-senior-developer.agent.yaml - PHP Laravel development
• frontend-senior-react-developer.agent.yaml - React development
• react-native-senior-developer.agent.yaml - React Native development
• database-engineer-senior.agent.yaml - Database design & optimization

Workflows:

• backend-development/ - Backend implementation workflows
• frontend-development/ - Frontend implementation workflows

🔄 zns-migration (Optional)

Legacy system modernization

Agents:

• obsolescence-analysis.agent.yaml - Analyze obsolete technologies

Workflows:

• obsolescence-analysis-complete/ - Full obsolescence audit

🛠️ zns-utilities (Optional)

Cross-cutting utilities

Agents:

• c4-diagram-specialist.agent.yaml - C4 architecture diagrams
• cost-estimator-senior.agent.yaml - Effort & cost estimation
• exporting-documents.agent.yaml - Document generation
• prompt-engineer-senior.agent.yaml - AI prompt optimization
• technical-user-stories.agent.yaml - Technical story templates

✅ zns-validation (Optional)

Quality assurance workflows

Agents:

• validation-quality.agent.yaml - Code quality validation

⚙️ zns-devops (Optional)

DevSecOps workflows

Agents:

• devsecops-onpremise-senior.agent.yaml - On-premise DevSecOps

🔧 Configuration

.bmad-config.yaml

project:
  name: ZNS-METHOD
  version: 6.0.0

method:
  framework: BMAD-METHOD
  framework_version: 6.0.0-alpha.13
  modules:
    core: true
    audit: false
    development: false

agents:
  compilation:
    auto_compile: true
    output_format: xml
  
  customization:
    allow_customize: true
    preserve_on_update: true

workflows:
  phases:
    phase_0_enabled: true   # Documentation
    phase_1_enabled: true   # Analysis
    phase_2_enabled: true   # Planning
  
  scale_adaptive:
    enabled: true
    default_level: 2        # Medium complexity

🎨 Customizing Agents

Create a .customize.yaml file next to any agent:

# product-owner.customize.yaml
agent:
  persona:
    communication_style: |
      Use shorter sentences. Always include emojis. More casual tone.
  
  menu:
    - trigger: my-custom-workflow
      workflow: "{project-root}/my-workflows/custom.yaml"
      description: My custom workflow

Recompile:

npx znsmtd compile product-owner

Your customizations will persist across updates! 🎉

🧪 Testing & Validation

Validate Agent Schemas

npx znsmtd validate

Run Tests

npm test

Test Coverage

npm run test:coverage

📚 Documentation

• Agent Customization Guide: docs/agent-customization-guide.md
• Workflow Architecture: docs/workflow-architecture.md
• Phase System: docs/phase-system.md
• Scale-Adaptive Guide: docs/scale-adaptive-guide.md
• BMAD V6+ Reference: docs/BMAD-METHOD-main/README.md

🛣️ Roadmap

✅ Sprint 1: Foundation (COMPLETED)

• [x] NPM package structure (@bmad-method/framework)
• [x] CLI system scaffold
• [x] Agent compiler scaffold (YAML→XML)
• [x] V6+ schema migration (Product Owner example)
• [x] Configuration files (.bmad-config.yaml)

✅ Sprint 2: Workflows (COMPLETED)

• [x] Shard 4 workflows into granular step-files
• [x] context-consolidation (3 variants: default, level-0, level-3)
• [x] architecture-definition
• [x] data-modeling
• [x] user-story-creation
• [x] Metadata complete (dependencies, parallel execution)

✅ Sprint 3: Agent Migration (COMPLETED)

• [x] Migrate 21 agents to V6+ 2.2.0 schema
• [x] Full personas (name, role, experience, communication_style, expertise_areas)
• [x] Scale-adaptive (supported_levels: [0,1,2,3,4], adaptations)
• [x] Structured menus (trigger, label, workflow, description)
• [x] 100% validation pass rate

✅ Sprint 4: Scale-Adaptive System (COMPLETED)

• [x] Level detector (0-4 complexity detection)
• [x] Workflow selector (variant selection with fallback)
• [x] Confidence scoring + recommendations
• [x] CLI integration (executable scripts)
• [x] 2 workflow variants created

✅ Sprint 5: Testing & Validation (COMPLETED)

• [x] testarch/ directory structure
• [x] 2 JSON Schemas (agent-v6-schema.json, workflow-schema.json)
• [x] 2 Validators (agent-validator.js, workflow-validator.js)
• [x] 75 tests (65 unit + 10 integration) - 100% pass rate
• [x] Validation suite runner
• [x] Pre-commit hooks
• [x] GitHub Actions CI/CD (matrix Node 18.x, 20.x)

✅ Sprint 6: Documentation Hub (COMPLETED)

• [x] API documentation (1,200+ lines)
• [x] Getting Started tutorial (600+ lines)
• [x] Agent Development Guide (800+ lines)
• [x] Package.json v6.0.0 configured
• [x] CHANGELOG, CONTRIBUTING, LICENSE
• [x] Professional README

📅 Post-V6.0 Roadmap (v6.1 - v7.0)

• [ ] Implement agent compiler (YAML→XML conversion)
• [ ] workflow-init & workflow-status commands
• [ ] Customization system (.customize.yaml merge)
• [ ] Module-specific READMEs
• [ ] More workflow variants (architecture, data-modeling)
• [ ] NPM publish (@bmad-method/framework)
• [ ] Visual Workflow Editor (Web UI)
• [ ] Cloud execution backend
• [ ] Plugin marketplace

🤝 Contributing

Contributions are welcome! Please follow these guidelines:

1. Fork the repository
2. Create a feature branch: git checkout -b feature/my-feature
3. Follow V6+ schema: All agents must comply with BMAD-METHOD V6+
4. Validate before committing: npx znsmtd validate
5. Submit a pull request

📄 License

MIT License - See LICENSE for details

🙏 Acknowledgments

Built on top of BMAD-METHOD V6+

📞 Support

• Issues: GitHub Issues
• Documentation: docs/
• Email: [email protected]

Made with ❤️ by the Maldivati Project