ZNS-METHOD Framework - Business Modeling & Application Development Framework with Scale-Adaptive Intelligence based on BMAD-METHOD V6+
npm install @znsmtd/framework{project-root}, {bmad_folder}, {output_folder}
.customize.yaml overlay system for persistent agent personalization
bash
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
`
$3
`
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
$3
`bash
Install globally via NPM
npm install -g @znsmtd/framework
Or use directly via npx
npx @znsmtd/framework install
or
npx znsmtd install
`
$3
`bash
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)
$3
`bash
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
$3
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
---
$3
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
---
$3
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
---
$3
Legacy system modernization
Agents:
- obsolescence-analysis.agent.yaml - Analyze obsolete technologies
Workflows:
- obsolescence-analysis-complete/ - Full obsolescence audit
---
$3
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
---
$3
Quality assurance workflows
Agents:
- validation-quality.agent.yaml - Code quality validation
---
$3
DevSecOps workflows
Agents:
- devsecops-onpremise-senior.agent.yaml - On-premise DevSecOps
---
π§ Configuration
$3
`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:
`yaml
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:
`bash
npx znsmtd compile product-owner
`
Your customizations will persist across updates! π
---
π§ͺ Testing & Validation
$3
`bash
npx znsmtd validate
`
$3
`bash
npm test
`
$3
`bash
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
$3
- [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)
$3
- [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)
$3
- [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
$3
- [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
$3
- [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)
$3
- [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
$3
- [ ] 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/`