frappe-builder 1.1.0-dev.8
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/.fb/state.db +0 -0
- package/AGENTS.md +167 -0
- package/README.md +89 -0
- package/_bmad/_config/agent-manifest.csv +10 -0
- package/_bmad/_config/agents/bmm-analyst.customize.yaml +41 -0
- package/_bmad/_config/agents/bmm-architect.customize.yaml +41 -0
- package/_bmad/_config/agents/bmm-dev.customize.yaml +41 -0
- package/_bmad/_config/agents/bmm-pm.customize.yaml +41 -0
- package/_bmad/_config/agents/bmm-qa.customize.yaml +41 -0
- package/_bmad/_config/agents/bmm-quick-flow-solo-dev.customize.yaml +41 -0
- package/_bmad/_config/agents/bmm-sm.customize.yaml +41 -0
- package/_bmad/_config/agents/bmm-tech-writer.customize.yaml +41 -0
- package/_bmad/_config/agents/bmm-ux-designer.customize.yaml +41 -0
- package/_bmad/_config/bmad-help.csv +47 -0
- package/_bmad/_config/files-manifest.csv +369 -0
- package/_bmad/_config/ides/claude-code.yaml +5 -0
- package/_bmad/_config/manifest.yaml +28 -0
- package/_bmad/_config/skill-manifest.csv +41 -0
- package/_bmad/_config/task-manifest.csv +1 -0
- package/_bmad/_config/tool-manifest.csv +1 -0
- package/_bmad/_config/workflow-manifest.csv +1 -0
- package/_bmad/_memory/config.yaml +11 -0
- package/_bmad/_memory/tech-writer-sidecar/documentation-standards.md +224 -0
- package/_bmad/bmm/agents/analyst.md +69 -0
- package/_bmad/bmm/agents/architect.md +59 -0
- package/_bmad/bmm/agents/bmad-skill-manifest.yaml +39 -0
- package/_bmad/bmm/agents/dev.md +66 -0
- package/_bmad/bmm/agents/pm.md +63 -0
- package/_bmad/bmm/agents/qa.md +89 -0
- package/_bmad/bmm/agents/quick-flow-solo-dev.md +61 -0
- package/_bmad/bmm/agents/sm.md +67 -0
- package/_bmad/bmm/agents/tech-writer/bmad-skill-manifest.yaml +3 -0
- package/_bmad/bmm/agents/tech-writer/tech-writer.md +67 -0
- package/_bmad/bmm/agents/ux-designer.md +58 -0
- package/_bmad/bmm/config.yaml +16 -0
- package/_bmad/bmm/data/project-context-template.md +26 -0
- package/_bmad/bmm/module-help.csv +32 -0
- package/_bmad/bmm/teams/default-party.csv +20 -0
- package/_bmad/bmm/teams/team-fullstack.yaml +12 -0
- package/_bmad/bmm/workflows/1-analysis/bmad-create-product-brief/SKILL.md +6 -0
- package/_bmad/bmm/workflows/1-analysis/bmad-create-product-brief/bmad-skill-manifest.yaml +1 -0
- package/_bmad/bmm/workflows/1-analysis/bmad-create-product-brief/product-brief.template.md +10 -0
- package/_bmad/bmm/workflows/1-analysis/bmad-create-product-brief/steps/step-01-init.md +170 -0
- package/_bmad/bmm/workflows/1-analysis/bmad-create-product-brief/steps/step-01b-continue.md +158 -0
- package/_bmad/bmm/workflows/1-analysis/bmad-create-product-brief/steps/step-02-vision.md +193 -0
- package/_bmad/bmm/workflows/1-analysis/bmad-create-product-brief/steps/step-03-users.md +196 -0
- package/_bmad/bmm/workflows/1-analysis/bmad-create-product-brief/steps/step-04-metrics.md +199 -0
- package/_bmad/bmm/workflows/1-analysis/bmad-create-product-brief/steps/step-05-scope.md +213 -0
- package/_bmad/bmm/workflows/1-analysis/bmad-create-product-brief/steps/step-06-complete.md +159 -0
- package/_bmad/bmm/workflows/1-analysis/bmad-create-product-brief/workflow.md +55 -0
- package/_bmad/bmm/workflows/1-analysis/bmad-product-brief-preview/SKILL.md +88 -0
- package/_bmad/bmm/workflows/1-analysis/bmad-product-brief-preview/agents/artifact-analyzer.md +60 -0
- package/_bmad/bmm/workflows/1-analysis/bmad-product-brief-preview/agents/opportunity-reviewer.md +44 -0
- package/_bmad/bmm/workflows/1-analysis/bmad-product-brief-preview/agents/skeptic-reviewer.md +44 -0
- package/_bmad/bmm/workflows/1-analysis/bmad-product-brief-preview/agents/web-researcher.md +49 -0
- package/_bmad/bmm/workflows/1-analysis/bmad-product-brief-preview/bmad-manifest.json +17 -0
- package/_bmad/bmm/workflows/1-analysis/bmad-product-brief-preview/bmad-skill-manifest.yaml +1 -0
- package/_bmad/bmm/workflows/1-analysis/bmad-product-brief-preview/prompts/contextual-discovery.md +57 -0
- package/_bmad/bmm/workflows/1-analysis/bmad-product-brief-preview/prompts/draft-and-review.md +86 -0
- package/_bmad/bmm/workflows/1-analysis/bmad-product-brief-preview/prompts/finalize.md +75 -0
- package/_bmad/bmm/workflows/1-analysis/bmad-product-brief-preview/prompts/guided-elicitation.md +70 -0
- package/_bmad/bmm/workflows/1-analysis/bmad-product-brief-preview/resources/brief-template.md +60 -0
- package/_bmad/bmm/workflows/1-analysis/research/bmad-domain-research/SKILL.md +6 -0
- package/_bmad/bmm/workflows/1-analysis/research/bmad-domain-research/bmad-skill-manifest.yaml +1 -0
- package/_bmad/bmm/workflows/1-analysis/research/bmad-domain-research/domain-steps/step-01-init.md +137 -0
- package/_bmad/bmm/workflows/1-analysis/research/bmad-domain-research/domain-steps/step-02-domain-analysis.md +229 -0
- package/_bmad/bmm/workflows/1-analysis/research/bmad-domain-research/domain-steps/step-03-competitive-landscape.md +238 -0
- package/_bmad/bmm/workflows/1-analysis/research/bmad-domain-research/domain-steps/step-04-regulatory-focus.md +206 -0
- package/_bmad/bmm/workflows/1-analysis/research/bmad-domain-research/domain-steps/step-05-technical-trends.md +234 -0
- package/_bmad/bmm/workflows/1-analysis/research/bmad-domain-research/domain-steps/step-06-research-synthesis.md +444 -0
- package/_bmad/bmm/workflows/1-analysis/research/bmad-domain-research/research.template.md +29 -0
- package/_bmad/bmm/workflows/1-analysis/research/bmad-domain-research/workflow.md +49 -0
- package/_bmad/bmm/workflows/1-analysis/research/bmad-market-research/SKILL.md +6 -0
- package/_bmad/bmm/workflows/1-analysis/research/bmad-market-research/bmad-skill-manifest.yaml +1 -0
- package/_bmad/bmm/workflows/1-analysis/research/bmad-market-research/research.template.md +29 -0
- package/_bmad/bmm/workflows/1-analysis/research/bmad-market-research/steps/step-01-init.md +184 -0
- package/_bmad/bmm/workflows/1-analysis/research/bmad-market-research/steps/step-02-customer-behavior.md +239 -0
- package/_bmad/bmm/workflows/1-analysis/research/bmad-market-research/steps/step-03-customer-pain-points.md +251 -0
- package/_bmad/bmm/workflows/1-analysis/research/bmad-market-research/steps/step-04-customer-decisions.md +261 -0
- package/_bmad/bmm/workflows/1-analysis/research/bmad-market-research/steps/step-05-competitive-analysis.md +173 -0
- package/_bmad/bmm/workflows/1-analysis/research/bmad-market-research/steps/step-06-research-completion.md +478 -0
- package/_bmad/bmm/workflows/1-analysis/research/bmad-market-research/workflow.md +49 -0
- package/_bmad/bmm/workflows/1-analysis/research/bmad-technical-research/SKILL.md +6 -0
- package/_bmad/bmm/workflows/1-analysis/research/bmad-technical-research/bmad-skill-manifest.yaml +1 -0
- package/_bmad/bmm/workflows/1-analysis/research/bmad-technical-research/research.template.md +29 -0
- package/_bmad/bmm/workflows/1-analysis/research/bmad-technical-research/technical-steps/step-01-init.md +137 -0
- package/_bmad/bmm/workflows/1-analysis/research/bmad-technical-research/technical-steps/step-02-technical-overview.md +239 -0
- package/_bmad/bmm/workflows/1-analysis/research/bmad-technical-research/technical-steps/step-03-integration-patterns.md +248 -0
- package/_bmad/bmm/workflows/1-analysis/research/bmad-technical-research/technical-steps/step-04-architectural-patterns.md +202 -0
- package/_bmad/bmm/workflows/1-analysis/research/bmad-technical-research/technical-steps/step-05-implementation-research.md +233 -0
- package/_bmad/bmm/workflows/1-analysis/research/bmad-technical-research/technical-steps/step-06-research-synthesis.md +487 -0
- package/_bmad/bmm/workflows/1-analysis/research/bmad-technical-research/workflow.md +50 -0
- package/_bmad/bmm/workflows/1-analysis/research/market-steps/step-01-init.md +182 -0
- package/_bmad/bmm/workflows/1-analysis/research/market-steps/step-02-customer-behavior.md +237 -0
- package/_bmad/bmm/workflows/1-analysis/research/market-steps/step-03-customer-pain-points.md +249 -0
- package/_bmad/bmm/workflows/1-analysis/research/market-steps/step-04-customer-decisions.md +259 -0
- package/_bmad/bmm/workflows/1-analysis/research/market-steps/step-05-competitive-analysis.md +177 -0
- package/_bmad/bmm/workflows/1-analysis/research/market-steps/step-06-research-completion.md +476 -0
- package/_bmad/bmm/workflows/1-analysis/research/research.template.md +29 -0
- package/_bmad/bmm/workflows/2-plan-workflows/bmad-create-ux-design/SKILL.md +6 -0
- package/_bmad/bmm/workflows/2-plan-workflows/bmad-create-ux-design/bmad-skill-manifest.yaml +1 -0
- package/_bmad/bmm/workflows/2-plan-workflows/bmad-create-ux-design/steps/step-01-init.md +135 -0
- package/_bmad/bmm/workflows/2-plan-workflows/bmad-create-ux-design/steps/step-01b-continue.md +127 -0
- package/_bmad/bmm/workflows/2-plan-workflows/bmad-create-ux-design/steps/step-02-discovery.md +190 -0
- package/_bmad/bmm/workflows/2-plan-workflows/bmad-create-ux-design/steps/step-03-core-experience.md +217 -0
- package/_bmad/bmm/workflows/2-plan-workflows/bmad-create-ux-design/steps/step-04-emotional-response.md +220 -0
- package/_bmad/bmm/workflows/2-plan-workflows/bmad-create-ux-design/steps/step-05-inspiration.md +235 -0
- package/_bmad/bmm/workflows/2-plan-workflows/bmad-create-ux-design/steps/step-06-design-system.md +253 -0
- package/_bmad/bmm/workflows/2-plan-workflows/bmad-create-ux-design/steps/step-07-defining-experience.md +255 -0
- package/_bmad/bmm/workflows/2-plan-workflows/bmad-create-ux-design/steps/step-08-visual-foundation.md +225 -0
- package/_bmad/bmm/workflows/2-plan-workflows/bmad-create-ux-design/steps/step-09-design-directions.md +225 -0
- package/_bmad/bmm/workflows/2-plan-workflows/bmad-create-ux-design/steps/step-10-user-journeys.md +242 -0
- package/_bmad/bmm/workflows/2-plan-workflows/bmad-create-ux-design/steps/step-11-component-strategy.md +249 -0
- package/_bmad/bmm/workflows/2-plan-workflows/bmad-create-ux-design/steps/step-12-ux-patterns.md +238 -0
- package/_bmad/bmm/workflows/2-plan-workflows/bmad-create-ux-design/steps/step-13-responsive-accessibility.md +265 -0
- package/_bmad/bmm/workflows/2-plan-workflows/bmad-create-ux-design/steps/step-14-complete.md +171 -0
- package/_bmad/bmm/workflows/2-plan-workflows/bmad-create-ux-design/ux-design-template.md +13 -0
- package/_bmad/bmm/workflows/2-plan-workflows/bmad-create-ux-design/workflow.md +36 -0
- package/_bmad/bmm/workflows/2-plan-workflows/bmad-edit-prd/SKILL.md +6 -0
- package/_bmad/bmm/workflows/2-plan-workflows/bmad-edit-prd/bmad-skill-manifest.yaml +1 -0
- package/_bmad/bmm/workflows/2-plan-workflows/bmad-edit-prd/steps-e/step-e-01-discovery.md +242 -0
- package/_bmad/bmm/workflows/2-plan-workflows/bmad-edit-prd/steps-e/step-e-01b-legacy-conversion.md +204 -0
- package/_bmad/bmm/workflows/2-plan-workflows/bmad-edit-prd/steps-e/step-e-02-review.md +245 -0
- package/_bmad/bmm/workflows/2-plan-workflows/bmad-edit-prd/steps-e/step-e-03-edit.md +250 -0
- package/_bmad/bmm/workflows/2-plan-workflows/bmad-edit-prd/steps-e/step-e-04-complete.md +165 -0
- package/_bmad/bmm/workflows/2-plan-workflows/bmad-edit-prd/workflow.md +63 -0
- package/_bmad/bmm/workflows/2-plan-workflows/bmad-validate-prd/SKILL.md +6 -0
- package/_bmad/bmm/workflows/2-plan-workflows/bmad-validate-prd/bmad-skill-manifest.yaml +1 -0
- package/_bmad/bmm/workflows/2-plan-workflows/bmad-validate-prd/data/domain-complexity.csv +15 -0
- package/_bmad/bmm/workflows/2-plan-workflows/bmad-validate-prd/data/prd-purpose.md +197 -0
- package/_bmad/bmm/workflows/2-plan-workflows/bmad-validate-prd/data/project-types.csv +11 -0
- package/_bmad/bmm/workflows/2-plan-workflows/bmad-validate-prd/steps-v/step-v-01-discovery.md +221 -0
- package/_bmad/bmm/workflows/2-plan-workflows/bmad-validate-prd/steps-v/step-v-02-format-detection.md +188 -0
- package/_bmad/bmm/workflows/2-plan-workflows/bmad-validate-prd/steps-v/step-v-02b-parity-check.md +206 -0
- package/_bmad/bmm/workflows/2-plan-workflows/bmad-validate-prd/steps-v/step-v-03-density-validation.md +171 -0
- package/_bmad/bmm/workflows/2-plan-workflows/bmad-validate-prd/steps-v/step-v-04-brief-coverage-validation.md +211 -0
- package/_bmad/bmm/workflows/2-plan-workflows/bmad-validate-prd/steps-v/step-v-05-measurability-validation.md +225 -0
- package/_bmad/bmm/workflows/2-plan-workflows/bmad-validate-prd/steps-v/step-v-06-traceability-validation.md +214 -0
- package/_bmad/bmm/workflows/2-plan-workflows/bmad-validate-prd/steps-v/step-v-07-implementation-leakage-validation.md +202 -0
- package/_bmad/bmm/workflows/2-plan-workflows/bmad-validate-prd/steps-v/step-v-08-domain-compliance-validation.md +240 -0
- package/_bmad/bmm/workflows/2-plan-workflows/bmad-validate-prd/steps-v/step-v-09-project-type-validation.md +260 -0
- package/_bmad/bmm/workflows/2-plan-workflows/bmad-validate-prd/steps-v/step-v-10-smart-validation.md +206 -0
- package/_bmad/bmm/workflows/2-plan-workflows/bmad-validate-prd/steps-v/step-v-11-holistic-quality-validation.md +261 -0
- package/_bmad/bmm/workflows/2-plan-workflows/bmad-validate-prd/steps-v/step-v-12-completeness-validation.md +239 -0
- package/_bmad/bmm/workflows/2-plan-workflows/bmad-validate-prd/steps-v/step-v-13-report-complete.md +229 -0
- package/_bmad/bmm/workflows/2-plan-workflows/bmad-validate-prd/workflow.md +62 -0
- package/_bmad/bmm/workflows/2-plan-workflows/create-prd/data/domain-complexity.csv +15 -0
- package/_bmad/bmm/workflows/2-plan-workflows/create-prd/data/prd-purpose.md +197 -0
- package/_bmad/bmm/workflows/2-plan-workflows/create-prd/data/project-types.csv +11 -0
- package/_bmad/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-01-discovery.md +224 -0
- package/_bmad/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-02-format-detection.md +191 -0
- package/_bmad/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-02b-parity-check.md +209 -0
- package/_bmad/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-03-density-validation.md +174 -0
- package/_bmad/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-04-brief-coverage-validation.md +214 -0
- package/_bmad/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-05-measurability-validation.md +228 -0
- package/_bmad/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-06-traceability-validation.md +217 -0
- package/_bmad/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-07-implementation-leakage-validation.md +205 -0
- package/_bmad/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-08-domain-compliance-validation.md +243 -0
- package/_bmad/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-09-project-type-validation.md +263 -0
- package/_bmad/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-10-smart-validation.md +209 -0
- package/_bmad/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-11-holistic-quality-validation.md +264 -0
- package/_bmad/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-12-completeness-validation.md +242 -0
- package/_bmad/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-13-report-complete.md +232 -0
- package/_bmad/bmm/workflows/2-plan-workflows/create-prd/workflow-validate-prd.md +65 -0
- package/_bmad/bmm/workflows/3-solutioning/bmad-check-implementation-readiness/SKILL.md +6 -0
- package/_bmad/bmm/workflows/3-solutioning/bmad-check-implementation-readiness/bmad-skill-manifest.yaml +1 -0
- package/_bmad/bmm/workflows/3-solutioning/bmad-check-implementation-readiness/steps/step-01-document-discovery.md +179 -0
- package/_bmad/bmm/workflows/3-solutioning/bmad-check-implementation-readiness/steps/step-02-prd-analysis.md +168 -0
- package/_bmad/bmm/workflows/3-solutioning/bmad-check-implementation-readiness/steps/step-03-epic-coverage-validation.md +169 -0
- package/_bmad/bmm/workflows/3-solutioning/bmad-check-implementation-readiness/steps/step-04-ux-alignment.md +129 -0
- package/_bmad/bmm/workflows/3-solutioning/bmad-check-implementation-readiness/steps/step-05-epic-quality-review.md +241 -0
- package/_bmad/bmm/workflows/3-solutioning/bmad-check-implementation-readiness/steps/step-06-final-assessment.md +126 -0
- package/_bmad/bmm/workflows/3-solutioning/bmad-check-implementation-readiness/templates/readiness-report-template.md +4 -0
- package/_bmad/bmm/workflows/3-solutioning/bmad-check-implementation-readiness/workflow.md +49 -0
- package/_bmad/bmm/workflows/3-solutioning/bmad-create-architecture/SKILL.md +6 -0
- package/_bmad/bmm/workflows/3-solutioning/bmad-create-architecture/architecture-decision-template.md +12 -0
- package/_bmad/bmm/workflows/3-solutioning/bmad-create-architecture/bmad-skill-manifest.yaml +1 -0
- package/_bmad/bmm/workflows/3-solutioning/bmad-create-architecture/data/domain-complexity.csv +13 -0
- package/_bmad/bmm/workflows/3-solutioning/bmad-create-architecture/data/project-types.csv +7 -0
- package/_bmad/bmm/workflows/3-solutioning/bmad-create-architecture/steps/step-01-init.md +153 -0
- package/_bmad/bmm/workflows/3-solutioning/bmad-create-architecture/steps/step-01b-continue.md +173 -0
- package/_bmad/bmm/workflows/3-solutioning/bmad-create-architecture/steps/step-02-context.md +224 -0
- package/_bmad/bmm/workflows/3-solutioning/bmad-create-architecture/steps/step-03-starter.md +329 -0
- package/_bmad/bmm/workflows/3-solutioning/bmad-create-architecture/steps/step-04-decisions.md +318 -0
- package/_bmad/bmm/workflows/3-solutioning/bmad-create-architecture/steps/step-05-patterns.md +359 -0
- package/_bmad/bmm/workflows/3-solutioning/bmad-create-architecture/steps/step-06-structure.md +379 -0
- package/_bmad/bmm/workflows/3-solutioning/bmad-create-architecture/steps/step-07-validation.md +359 -0
- package/_bmad/bmm/workflows/3-solutioning/bmad-create-architecture/steps/step-08-complete.md +76 -0
- package/_bmad/bmm/workflows/3-solutioning/bmad-create-architecture/workflow.md +38 -0
- package/_bmad/bmm/workflows/3-solutioning/bmad-create-epics-and-stories/SKILL.md +6 -0
- package/_bmad/bmm/workflows/3-solutioning/bmad-create-epics-and-stories/bmad-skill-manifest.yaml +1 -0
- package/_bmad/bmm/workflows/3-solutioning/bmad-create-epics-and-stories/steps/step-01-validate-prerequisites.md +255 -0
- package/_bmad/bmm/workflows/3-solutioning/bmad-create-epics-and-stories/steps/step-02-design-epics.md +212 -0
- package/_bmad/bmm/workflows/3-solutioning/bmad-create-epics-and-stories/steps/step-03-create-stories.md +255 -0
- package/_bmad/bmm/workflows/3-solutioning/bmad-create-epics-and-stories/steps/step-04-final-validation.md +131 -0
- package/_bmad/bmm/workflows/3-solutioning/bmad-create-epics-and-stories/templates/epics-template.md +61 -0
- package/_bmad/bmm/workflows/3-solutioning/bmad-create-epics-and-stories/workflow.md +53 -0
- package/_bmad/bmm/workflows/4-implementation/bmad-code-review/SKILL.md +6 -0
- package/_bmad/bmm/workflows/4-implementation/bmad-code-review/bmad-skill-manifest.yaml +1 -0
- package/_bmad/bmm/workflows/4-implementation/bmad-code-review/steps/step-01-gather-context.md +61 -0
- package/_bmad/bmm/workflows/4-implementation/bmad-code-review/steps/step-02-review.md +41 -0
- package/_bmad/bmm/workflows/4-implementation/bmad-code-review/steps/step-03-triage.md +50 -0
- package/_bmad/bmm/workflows/4-implementation/bmad-code-review/steps/step-04-present.md +38 -0
- package/_bmad/bmm/workflows/4-implementation/bmad-code-review/workflow.md +54 -0
- package/_bmad/bmm/workflows/4-implementation/bmad-correct-course/SKILL.md +6 -0
- package/_bmad/bmm/workflows/4-implementation/bmad-correct-course/bmad-skill-manifest.yaml +1 -0
- package/_bmad/bmm/workflows/4-implementation/bmad-correct-course/checklist.md +288 -0
- package/_bmad/bmm/workflows/4-implementation/bmad-correct-course/workflow.md +267 -0
- package/_bmad/bmm/workflows/4-implementation/bmad-create-story/SKILL.md +6 -0
- package/_bmad/bmm/workflows/4-implementation/bmad-create-story/bmad-skill-manifest.yaml +1 -0
- package/_bmad/bmm/workflows/4-implementation/bmad-create-story/checklist.md +357 -0
- package/_bmad/bmm/workflows/4-implementation/bmad-create-story/discover-inputs.md +88 -0
- package/_bmad/bmm/workflows/4-implementation/bmad-create-story/template.md +49 -0
- package/_bmad/bmm/workflows/4-implementation/bmad-create-story/workflow.md +380 -0
- package/_bmad/bmm/workflows/4-implementation/bmad-dev-story/SKILL.md +6 -0
- package/_bmad/bmm/workflows/4-implementation/bmad-dev-story/bmad-skill-manifest.yaml +1 -0
- package/_bmad/bmm/workflows/4-implementation/bmad-dev-story/checklist.md +80 -0
- package/_bmad/bmm/workflows/4-implementation/bmad-dev-story/workflow.md +450 -0
- package/_bmad/bmm/workflows/4-implementation/bmad-retrospective/SKILL.md +6 -0
- package/_bmad/bmm/workflows/4-implementation/bmad-retrospective/bmad-skill-manifest.yaml +1 -0
- package/_bmad/bmm/workflows/4-implementation/bmad-retrospective/workflow.md +1479 -0
- package/_bmad/bmm/workflows/4-implementation/bmad-sprint-planning/SKILL.md +6 -0
- package/_bmad/bmm/workflows/4-implementation/bmad-sprint-planning/bmad-skill-manifest.yaml +1 -0
- package/_bmad/bmm/workflows/4-implementation/bmad-sprint-planning/checklist.md +33 -0
- package/_bmad/bmm/workflows/4-implementation/bmad-sprint-planning/sprint-status-template.yaml +56 -0
- package/_bmad/bmm/workflows/4-implementation/bmad-sprint-planning/workflow.md +263 -0
- package/_bmad/bmm/workflows/4-implementation/bmad-sprint-status/SKILL.md +6 -0
- package/_bmad/bmm/workflows/4-implementation/bmad-sprint-status/bmad-skill-manifest.yaml +1 -0
- package/_bmad/bmm/workflows/4-implementation/bmad-sprint-status/workflow.md +261 -0
- package/_bmad/bmm/workflows/bmad-document-project/SKILL.md +6 -0
- package/_bmad/bmm/workflows/bmad-document-project/bmad-skill-manifest.yaml +1 -0
- package/_bmad/bmm/workflows/bmad-document-project/checklist.md +245 -0
- package/_bmad/bmm/workflows/bmad-document-project/documentation-requirements.csv +12 -0
- package/_bmad/bmm/workflows/bmad-document-project/instructions.md +128 -0
- package/_bmad/bmm/workflows/bmad-document-project/templates/deep-dive-template.md +345 -0
- package/_bmad/bmm/workflows/bmad-document-project/templates/index-template.md +169 -0
- package/_bmad/bmm/workflows/bmad-document-project/templates/project-overview-template.md +103 -0
- package/_bmad/bmm/workflows/bmad-document-project/templates/project-scan-report-schema.json +160 -0
- package/_bmad/bmm/workflows/bmad-document-project/templates/source-tree-template.md +135 -0
- package/_bmad/bmm/workflows/bmad-document-project/workflow.md +27 -0
- package/_bmad/bmm/workflows/bmad-document-project/workflows/deep-dive-instructions.md +299 -0
- package/_bmad/bmm/workflows/bmad-document-project/workflows/deep-dive-workflow.md +34 -0
- package/_bmad/bmm/workflows/bmad-document-project/workflows/full-scan-instructions.md +1107 -0
- package/_bmad/bmm/workflows/bmad-document-project/workflows/full-scan-workflow.md +34 -0
- package/_bmad/bmm/workflows/bmad-generate-project-context/SKILL.md +6 -0
- package/_bmad/bmm/workflows/bmad-generate-project-context/bmad-skill-manifest.yaml +1 -0
- package/_bmad/bmm/workflows/bmad-generate-project-context/project-context-template.md +21 -0
- package/_bmad/bmm/workflows/bmad-generate-project-context/steps/step-01-discover.md +186 -0
- package/_bmad/bmm/workflows/bmad-generate-project-context/steps/step-02-generate.md +321 -0
- package/_bmad/bmm/workflows/bmad-generate-project-context/steps/step-03-complete.md +278 -0
- package/_bmad/bmm/workflows/bmad-generate-project-context/workflow.md +43 -0
- package/_bmad/bmm/workflows/bmad-qa-generate-e2e-tests/SKILL.md +6 -0
- package/_bmad/bmm/workflows/bmad-qa-generate-e2e-tests/bmad-skill-manifest.yaml +1 -0
- package/_bmad/bmm/workflows/bmad-qa-generate-e2e-tests/checklist.md +33 -0
- package/_bmad/bmm/workflows/bmad-qa-generate-e2e-tests/workflow.md +136 -0
- package/_bmad/bmm/workflows/bmad-quick-flow/bmad-quick-dev/SKILL.md +6 -0
- package/_bmad/bmm/workflows/bmad-quick-flow/bmad-quick-dev/bmad-skill-manifest.yaml +1 -0
- package/_bmad/bmm/workflows/bmad-quick-flow/bmad-quick-dev/steps/step-01-mode-detection.md +169 -0
- package/_bmad/bmm/workflows/bmad-quick-flow/bmad-quick-dev/steps/step-02-context-gathering.md +114 -0
- package/_bmad/bmm/workflows/bmad-quick-flow/bmad-quick-dev/steps/step-03-execute.md +107 -0
- package/_bmad/bmm/workflows/bmad-quick-flow/bmad-quick-dev/steps/step-04-self-check.md +107 -0
- package/_bmad/bmm/workflows/bmad-quick-flow/bmad-quick-dev/steps/step-05-adversarial-review.md +94 -0
- package/_bmad/bmm/workflows/bmad-quick-flow/bmad-quick-dev/steps/step-06-resolve-findings.md +144 -0
- package/_bmad/bmm/workflows/bmad-quick-flow/bmad-quick-dev/workflow.md +38 -0
- package/_bmad/bmm/workflows/bmad-quick-flow/bmad-quick-dev-new-preview/SKILL.md +6 -0
- package/_bmad/bmm/workflows/bmad-quick-flow/bmad-quick-dev-new-preview/bmad-skill-manifest.yaml +1 -0
- package/_bmad/bmm/workflows/bmad-quick-flow/bmad-quick-dev-new-preview/steps/step-01-clarify-and-route.md +51 -0
- package/_bmad/bmm/workflows/bmad-quick-flow/bmad-quick-dev-new-preview/steps/step-02-plan.md +35 -0
- package/_bmad/bmm/workflows/bmad-quick-flow/bmad-quick-dev-new-preview/steps/step-03-implement.md +33 -0
- package/_bmad/bmm/workflows/bmad-quick-flow/bmad-quick-dev-new-preview/steps/step-04-review.md +50 -0
- package/_bmad/bmm/workflows/bmad-quick-flow/bmad-quick-dev-new-preview/steps/step-05-present.md +17 -0
- package/_bmad/bmm/workflows/bmad-quick-flow/bmad-quick-dev-new-preview/tech-spec-template.md +90 -0
- package/_bmad/bmm/workflows/bmad-quick-flow/bmad-quick-dev-new-preview/workflow.md +79 -0
- package/_bmad/bmm/workflows/bmad-quick-flow/bmad-quick-spec/SKILL.md +6 -0
- package/_bmad/bmm/workflows/bmad-quick-flow/bmad-quick-spec/bmad-skill-manifest.yaml +1 -0
- package/_bmad/bmm/workflows/bmad-quick-flow/bmad-quick-spec/steps/step-01-understand.md +185 -0
- package/_bmad/bmm/workflows/bmad-quick-flow/bmad-quick-spec/steps/step-02-investigate.md +140 -0
- package/_bmad/bmm/workflows/bmad-quick-flow/bmad-quick-spec/steps/step-03-generate.md +123 -0
- package/_bmad/bmm/workflows/bmad-quick-flow/bmad-quick-spec/steps/step-04-review.md +195 -0
- package/_bmad/bmm/workflows/bmad-quick-flow/bmad-quick-spec/tech-spec-template.md +74 -0
- package/_bmad/bmm/workflows/bmad-quick-flow/bmad-quick-spec/workflow.md +73 -0
- package/_bmad/cis/config.yaml +12 -0
- package/_bmad/cis/module-help.csv +6 -0
- package/_bmad/cis/skills/bmad-cis-agent-brainstorming-coach/SKILL.md +51 -0
- package/_bmad/cis/skills/bmad-cis-agent-brainstorming-coach/bmad-skill-manifest.yaml +11 -0
- package/_bmad/cis/skills/bmad-cis-agent-creative-problem-solver/SKILL.md +51 -0
- package/_bmad/cis/skills/bmad-cis-agent-creative-problem-solver/bmad-skill-manifest.yaml +11 -0
- package/_bmad/cis/skills/bmad-cis-agent-design-thinking-coach/SKILL.md +52 -0
- package/_bmad/cis/skills/bmad-cis-agent-design-thinking-coach/bmad-skill-manifest.yaml +11 -0
- package/_bmad/cis/skills/bmad-cis-agent-innovation-strategist/SKILL.md +51 -0
- package/_bmad/cis/skills/bmad-cis-agent-innovation-strategist/bmad-skill-manifest.yaml +11 -0
- package/_bmad/cis/skills/bmad-cis-agent-presentation-master/SKILL.md +62 -0
- package/_bmad/cis/skills/bmad-cis-agent-presentation-master/bmad-skill-manifest.yaml +11 -0
- package/_bmad/cis/skills/bmad-cis-agent-storyteller/SKILL.md +56 -0
- package/_bmad/cis/skills/bmad-cis-agent-storyteller/bmad-skill-manifest.yaml +11 -0
- package/_bmad/cis/skills/bmad-cis-agent-storyteller/stories-told.md +7 -0
- package/_bmad/cis/skills/bmad-cis-agent-storyteller/story-preferences.md +7 -0
- package/_bmad/cis/skills/bmad-cis-design-thinking/SKILL.md +6 -0
- package/_bmad/cis/skills/bmad-cis-design-thinking/bmad-skill-manifest.yaml +1 -0
- package/_bmad/cis/skills/bmad-cis-design-thinking/design-methods.csv +31 -0
- package/_bmad/cis/skills/bmad-cis-design-thinking/template.md +111 -0
- package/_bmad/cis/skills/bmad-cis-design-thinking/workflow.md +242 -0
- package/_bmad/cis/skills/bmad-cis-innovation-strategy/SKILL.md +6 -0
- package/_bmad/cis/skills/bmad-cis-innovation-strategy/bmad-skill-manifest.yaml +1 -0
- package/_bmad/cis/skills/bmad-cis-innovation-strategy/innovation-frameworks.csv +31 -0
- package/_bmad/cis/skills/bmad-cis-innovation-strategy/template.md +189 -0
- package/_bmad/cis/skills/bmad-cis-innovation-strategy/workflow.md +315 -0
- package/_bmad/cis/skills/bmad-cis-problem-solving/SKILL.md +6 -0
- package/_bmad/cis/skills/bmad-cis-problem-solving/bmad-skill-manifest.yaml +1 -0
- package/_bmad/cis/skills/bmad-cis-problem-solving/solving-methods.csv +31 -0
- package/_bmad/cis/skills/bmad-cis-problem-solving/template.md +165 -0
- package/_bmad/cis/skills/bmad-cis-problem-solving/workflow.md +291 -0
- package/_bmad/cis/skills/bmad-cis-storytelling/SKILL.md +6 -0
- package/_bmad/cis/skills/bmad-cis-storytelling/bmad-skill-manifest.yaml +1 -0
- package/_bmad/cis/skills/bmad-cis-storytelling/story-types.csv +26 -0
- package/_bmad/cis/skills/bmad-cis-storytelling/template.md +113 -0
- package/_bmad/cis/skills/bmad-cis-storytelling/workflow.md +321 -0
- package/_bmad/core/config.yaml +9 -0
- package/_bmad/core/module-help.csv +11 -0
- package/_bmad/core/skills/bmad-advanced-elicitation/SKILL.md +6 -0
- package/_bmad/core/skills/bmad-advanced-elicitation/bmad-skill-manifest.yaml +1 -0
- package/_bmad/core/skills/bmad-advanced-elicitation/methods.csv +51 -0
- package/_bmad/core/skills/bmad-advanced-elicitation/workflow.md +135 -0
- package/_bmad/core/skills/bmad-brainstorming/SKILL.md +6 -0
- package/_bmad/core/skills/bmad-brainstorming/bmad-skill-manifest.yaml +1 -0
- package/_bmad/core/skills/bmad-brainstorming/brain-methods.csv +62 -0
- package/_bmad/core/skills/bmad-brainstorming/steps/step-01-session-setup.md +214 -0
- package/_bmad/core/skills/bmad-brainstorming/steps/step-01b-continue.md +124 -0
- package/_bmad/core/skills/bmad-brainstorming/steps/step-02a-user-selected.md +229 -0
- package/_bmad/core/skills/bmad-brainstorming/steps/step-02b-ai-recommended.md +239 -0
- package/_bmad/core/skills/bmad-brainstorming/steps/step-02c-random-selection.md +211 -0
- package/_bmad/core/skills/bmad-brainstorming/steps/step-02d-progressive-flow.md +266 -0
- package/_bmad/core/skills/bmad-brainstorming/steps/step-03-technique-execution.md +401 -0
- package/_bmad/core/skills/bmad-brainstorming/steps/step-04-idea-organization.md +305 -0
- package/_bmad/core/skills/bmad-brainstorming/template.md +15 -0
- package/_bmad/core/skills/bmad-brainstorming/workflow.md +53 -0
- package/_bmad/core/skills/bmad-distillator/SKILL.md +178 -0
- package/_bmad/core/skills/bmad-distillator/agents/distillate-compressor.md +116 -0
- package/_bmad/core/skills/bmad-distillator/agents/round-trip-reconstructor.md +68 -0
- package/_bmad/core/skills/bmad-distillator/bmad-skill-manifest.yaml +15 -0
- package/_bmad/core/skills/bmad-distillator/resources/compression-rules.md +51 -0
- package/_bmad/core/skills/bmad-distillator/resources/distillate-format-reference.md +227 -0
- package/_bmad/core/skills/bmad-distillator/resources/splitting-strategy.md +78 -0
- package/_bmad/core/skills/bmad-editorial-review-prose/SKILL.md +6 -0
- package/_bmad/core/skills/bmad-editorial-review-prose/bmad-skill-manifest.yaml +1 -0
- package/_bmad/core/skills/bmad-editorial-review-prose/workflow.md +81 -0
- package/_bmad/core/skills/bmad-editorial-review-structure/SKILL.md +6 -0
- package/_bmad/core/skills/bmad-editorial-review-structure/bmad-skill-manifest.yaml +1 -0
- package/_bmad/core/skills/bmad-editorial-review-structure/workflow.md +174 -0
- package/_bmad/core/skills/bmad-help/SKILL.md +6 -0
- package/_bmad/core/skills/bmad-help/bmad-skill-manifest.yaml +1 -0
- package/_bmad/core/skills/bmad-help/workflow.md +88 -0
- package/_bmad/core/skills/bmad-index-docs/SKILL.md +6 -0
- package/_bmad/core/skills/bmad-index-docs/bmad-skill-manifest.yaml +1 -0
- package/_bmad/core/skills/bmad-index-docs/workflow.md +61 -0
- package/_bmad/core/skills/bmad-party-mode/SKILL.md +6 -0
- package/_bmad/core/skills/bmad-party-mode/bmad-skill-manifest.yaml +1 -0
- package/_bmad/core/skills/bmad-party-mode/steps/step-01-agent-loading.md +138 -0
- package/_bmad/core/skills/bmad-party-mode/steps/step-02-discussion-orchestration.md +187 -0
- package/_bmad/core/skills/bmad-party-mode/steps/step-03-graceful-exit.md +167 -0
- package/_bmad/core/skills/bmad-party-mode/workflow.md +190 -0
- package/_bmad/core/skills/bmad-review-adversarial-general/SKILL.md +6 -0
- package/_bmad/core/skills/bmad-review-adversarial-general/bmad-skill-manifest.yaml +1 -0
- package/_bmad/core/skills/bmad-review-adversarial-general/workflow.md +32 -0
- package/_bmad/core/skills/bmad-review-edge-case-hunter/SKILL.md +6 -0
- package/_bmad/core/skills/bmad-review-edge-case-hunter/bmad-skill-manifest.yaml +1 -0
- package/_bmad/core/skills/bmad-review-edge-case-hunter/workflow.md +62 -0
- package/_bmad/core/skills/bmad-shard-doc/SKILL.md +6 -0
- package/_bmad/core/skills/bmad-shard-doc/bmad-skill-manifest.yaml +1 -0
- package/_bmad/core/skills/bmad-shard-doc/workflow.md +100 -0
- package/_bmad/core/tasks/bmad-create-prd/SKILL.md +6 -0
- package/_bmad/core/tasks/bmad-create-prd/bmad-skill-manifest.yaml +1 -0
- package/_bmad/core/tasks/bmad-create-prd/data/domain-complexity.csv +15 -0
- package/_bmad/core/tasks/bmad-create-prd/data/prd-purpose.md +197 -0
- package/_bmad/core/tasks/bmad-create-prd/data/project-types.csv +11 -0
- package/_bmad/core/tasks/bmad-create-prd/steps-c/step-01-init.md +178 -0
- package/_bmad/core/tasks/bmad-create-prd/steps-c/step-01b-continue.md +161 -0
- package/_bmad/core/tasks/bmad-create-prd/steps-c/step-02-discovery.md +208 -0
- package/_bmad/core/tasks/bmad-create-prd/steps-c/step-02b-vision.md +142 -0
- package/_bmad/core/tasks/bmad-create-prd/steps-c/step-02c-executive-summary.md +158 -0
- package/_bmad/core/tasks/bmad-create-prd/steps-c/step-03-success.md +214 -0
- package/_bmad/core/tasks/bmad-create-prd/steps-c/step-04-journeys.md +201 -0
- package/_bmad/core/tasks/bmad-create-prd/steps-c/step-05-domain.md +194 -0
- package/_bmad/core/tasks/bmad-create-prd/steps-c/step-06-innovation.md +211 -0
- package/_bmad/core/tasks/bmad-create-prd/steps-c/step-07-project-type.md +222 -0
- package/_bmad/core/tasks/bmad-create-prd/steps-c/step-08-scoping.md +216 -0
- package/_bmad/core/tasks/bmad-create-prd/steps-c/step-09-functional.md +219 -0
- package/_bmad/core/tasks/bmad-create-prd/steps-c/step-10-nonfunctional.md +230 -0
- package/_bmad/core/tasks/bmad-create-prd/steps-c/step-11-polish.md +221 -0
- package/_bmad/core/tasks/bmad-create-prd/steps-c/step-12-complete.md +115 -0
- package/_bmad/core/tasks/bmad-create-prd/templates/prd-template.md +10 -0
- package/_bmad/core/tasks/bmad-create-prd/workflow.md +62 -0
- package/config/allowed-commands.ts +39 -0
- package/config/defaults.ts +19 -0
- package/config/loader.ts +105 -0
- package/extensions/frappe-gates.ts +160 -0
- package/extensions/frappe-session.ts +324 -0
- package/extensions/frappe-state.ts +235 -0
- package/extensions/frappe-tools.ts +278 -0
- package/extensions/frappe-ui.ts +119 -0
- package/extensions/frappe-workflow.ts +85 -0
- package/gates/coverage-check.ts +37 -0
- package/gates/frappe-native-check.ts +65 -0
- package/gates/permission-check.ts +65 -0
- package/gates/query-check.ts +40 -0
- package/gates/server-side-check.ts +67 -0
- package/gates/style-check.ts +92 -0
- package/gates/types.ts +13 -0
- package/package.json +43 -0
- package/project-context.md +146 -0
- package/state/db.ts +85 -0
- package/state/fsm.ts +68 -0
- package/state/journal.ts +164 -0
- package/state/schema.ts +41 -0
- package/tools/agent-tools.ts +60 -0
- package/tools/bench-tools.ts +63 -0
- package/tools/context-sandbox.ts +31 -0
- package/tools/debug-tools.ts +12 -0
- package/tools/feature-tools.ts +126 -0
- package/tools/frappe-context7.ts +70 -0
- package/tools/frappe-query-tools.ts +47 -0
- package/tools/project-tools.ts +107 -0
- package/tsdown.config.ts +6 -0
|
@@ -0,0 +1,68 @@
|
|
|
1
|
+
# Round-Trip Reconstructor Agent
|
|
2
|
+
|
|
3
|
+
Act as a document reconstruction specialist. Your purpose is to prove a distillate's completeness by reconstructing the original source documents from the distillate alone.
|
|
4
|
+
|
|
5
|
+
**Critical constraint:** You receive ONLY the distillate file path. You must NOT have access to the original source documents. If you can see the originals, the test is meaningless.
|
|
6
|
+
|
|
7
|
+
## Process
|
|
8
|
+
|
|
9
|
+
### Step 1: Analyze the Distillate
|
|
10
|
+
|
|
11
|
+
Read the distillate file. Parse the YAML frontmatter to identify:
|
|
12
|
+
- The `sources` list — what documents were distilled
|
|
13
|
+
- The `downstream_consumer` — what filtering may have been applied
|
|
14
|
+
- The `parts` count — whether this is a single or split distillate
|
|
15
|
+
|
|
16
|
+
### Step 2: Detect Document Types
|
|
17
|
+
|
|
18
|
+
From the source file names and the distillate's content, infer what type of document each source was:
|
|
19
|
+
- Product brief, discovery notes, research report, architecture doc, PRD, etc.
|
|
20
|
+
- Use the naming conventions and content themes to determine appropriate document structure
|
|
21
|
+
|
|
22
|
+
### Step 3: Reconstruct Each Source
|
|
23
|
+
|
|
24
|
+
For each source listed in the frontmatter, produce a full human-readable document:
|
|
25
|
+
|
|
26
|
+
- Use appropriate prose, structure, and formatting for the document type
|
|
27
|
+
- Include all sections the original document would have had based on the document type
|
|
28
|
+
- Expand compressed bullets back into natural language prose
|
|
29
|
+
- Restore section transitions and contextual framing
|
|
30
|
+
- Do NOT invent information — only use what is in the distillate
|
|
31
|
+
- Flag any places where the distillate felt insufficient with `[POSSIBLE GAP]` markers — these are critical quality signals
|
|
32
|
+
|
|
33
|
+
**Quality signals to watch for:**
|
|
34
|
+
- Bullets that feel like they're missing context → `[POSSIBLE GAP: missing context for X]`
|
|
35
|
+
- Themes that seem underrepresented given the document type → `[POSSIBLE GAP: expected more on X for a document of this type]`
|
|
36
|
+
- Relationships that are mentioned but not fully explained → `[POSSIBLE GAP: relationship between X and Y unclear]`
|
|
37
|
+
|
|
38
|
+
### Step 4: Save Reconstructions
|
|
39
|
+
|
|
40
|
+
Save each reconstructed document as a temporary file adjacent to the distillate:
|
|
41
|
+
- First source: `{distillate-basename}-reconstruction-1.md`
|
|
42
|
+
- Second source: `{distillate-basename}-reconstruction-2.md`
|
|
43
|
+
- And so on for each source
|
|
44
|
+
|
|
45
|
+
Each reconstruction should include a header noting it was reconstructed:
|
|
46
|
+
|
|
47
|
+
```markdown
|
|
48
|
+
---
|
|
49
|
+
type: distillate-reconstruction
|
|
50
|
+
source_distillate: "{distillate path}"
|
|
51
|
+
reconstructed_from: "{original source name}"
|
|
52
|
+
reconstruction_number: {N}
|
|
53
|
+
---
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
### Step 5: Return
|
|
57
|
+
|
|
58
|
+
Return a structured result to the calling skill:
|
|
59
|
+
|
|
60
|
+
```json
|
|
61
|
+
{
|
|
62
|
+
"reconstruction_files": ["{path1}", "{path2}"],
|
|
63
|
+
"possible_gaps": ["gap description 1", "gap description 2"],
|
|
64
|
+
"source_count": N
|
|
65
|
+
}
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
Do not include conversational text, status updates, or preamble — return only the structured result.
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
type: skill
|
|
2
|
+
module: core
|
|
3
|
+
capabilities:
|
|
4
|
+
- name: bmad-distillator
|
|
5
|
+
menu-code: DSTL
|
|
6
|
+
description: "Produces lossless LLM-optimized distillate from source documents. Use after producing large human presentable documents that will be consumed later by LLMs"
|
|
7
|
+
supports-headless: true
|
|
8
|
+
input: source documents
|
|
9
|
+
args: output, validate
|
|
10
|
+
output: single distillate or folder of distillates next to source input
|
|
11
|
+
config-vars-used: null
|
|
12
|
+
phase: anytime
|
|
13
|
+
before: []
|
|
14
|
+
after: []
|
|
15
|
+
is-required: false
|
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
# Compression Rules
|
|
2
|
+
|
|
3
|
+
These rules govern how source text is compressed into distillate format. Apply as a final pass over all output.
|
|
4
|
+
|
|
5
|
+
## Strip — Remove entirely
|
|
6
|
+
|
|
7
|
+
- Prose transitions: "As mentioned earlier", "It's worth noting", "In addition to this"
|
|
8
|
+
- Rhetoric and persuasion: "This is a game-changer", "The exciting thing is"
|
|
9
|
+
- Hedging: "We believe", "It's likely that", "Perhaps", "It seems"
|
|
10
|
+
- Self-reference: "This document describes", "As outlined above"
|
|
11
|
+
- Common knowledge explanations: "Vercel is a cloud platform company", "MIT is an open-source license", "JSON is a data interchange format"
|
|
12
|
+
- Repeated introductions of the same concept
|
|
13
|
+
- Section transition paragraphs
|
|
14
|
+
- Formatting-only elements (decorative bold/italic for emphasis, horizontal rules for visual breaks)
|
|
15
|
+
- Filler phrases: "In order to", "It should be noted that", "The fact that"
|
|
16
|
+
|
|
17
|
+
## Preserve — Keep always
|
|
18
|
+
|
|
19
|
+
- Specific numbers, dates, versions, percentages
|
|
20
|
+
- Named entities (products, companies, people, technologies)
|
|
21
|
+
- Decisions made and their rationale (compressed: "Decision: X. Reason: Y")
|
|
22
|
+
- Rejected alternatives and why (compressed: "Rejected: X. Reason: Y")
|
|
23
|
+
- Explicit constraints and non-negotiables
|
|
24
|
+
- Dependencies and ordering relationships
|
|
25
|
+
- Open questions and unresolved items
|
|
26
|
+
- Scope boundaries (in/out/deferred)
|
|
27
|
+
- Success criteria and how they're validated
|
|
28
|
+
- User segments and what success means for each
|
|
29
|
+
- Risks with their severity signals
|
|
30
|
+
- Conflicts between source documents
|
|
31
|
+
|
|
32
|
+
## Transform — Change form for efficiency
|
|
33
|
+
|
|
34
|
+
- Long prose paragraphs → single dense bullet capturing the same information
|
|
35
|
+
- "We decided to use X because Y and Z" → "X (rationale: Y, Z)"
|
|
36
|
+
- Repeated category labels → group under a single heading, no per-item labels
|
|
37
|
+
- "Risk: ... Severity: high" → "HIGH RISK: ..."
|
|
38
|
+
- Conditional statements → "If X → Y" form
|
|
39
|
+
- Multi-sentence explanations → semicolon-separated compressed form
|
|
40
|
+
- Lists of related short items → single bullet with semicolons
|
|
41
|
+
- "X is used for Y" → "X: Y" when context is clear
|
|
42
|
+
- Verbose enumerations → parenthetical lists: "platforms (Cursor, Claude Code, Windsurf, Copilot)"
|
|
43
|
+
|
|
44
|
+
## Deduplication Rules
|
|
45
|
+
|
|
46
|
+
- Same fact in multiple documents → keep the version with most context
|
|
47
|
+
- Same concept at different detail levels → keep the detailed version
|
|
48
|
+
- Overlapping lists → merge into single list, no duplicates
|
|
49
|
+
- When source documents disagree → note the conflict explicitly: "Brief says X; discovery notes say Y — unresolved"
|
|
50
|
+
- Executive summary points that are expanded elsewhere → keep only the expanded version
|
|
51
|
+
- Introductory framing repeated across sections → capture once under the most relevant theme
|
|
@@ -0,0 +1,227 @@
|
|
|
1
|
+
# Distillate Format Reference
|
|
2
|
+
|
|
3
|
+
Examples showing the transformation from human-readable source content to distillate format.
|
|
4
|
+
|
|
5
|
+
## Frontmatter
|
|
6
|
+
|
|
7
|
+
Every distillate includes YAML frontmatter. Source paths are relative to the distillate's location so the distillate remains portable:
|
|
8
|
+
|
|
9
|
+
```yaml
|
|
10
|
+
---
|
|
11
|
+
type: bmad-distillate
|
|
12
|
+
sources:
|
|
13
|
+
- "product-brief-example.md"
|
|
14
|
+
- "product-brief-example-discovery-notes.md"
|
|
15
|
+
downstream_consumer: "PRD creation"
|
|
16
|
+
created: "2026-03-13"
|
|
17
|
+
token_estimate: 1200
|
|
18
|
+
parts: 1
|
|
19
|
+
---
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
## Before/After Examples
|
|
23
|
+
|
|
24
|
+
### Prose Paragraph to Dense Bullet
|
|
25
|
+
|
|
26
|
+
**Before** (human-readable brief excerpt):
|
|
27
|
+
```
|
|
28
|
+
## What Makes This Different
|
|
29
|
+
|
|
30
|
+
**The anti-fragmentation layer.** The AI tooling space is fracturing across 40+
|
|
31
|
+
platforms with no shared methodology layer. BMAD is uniquely positioned to be the
|
|
32
|
+
cross-platform constant — the structured approach that works the same in Cursor,
|
|
33
|
+
Claude Code, Windsurf, Copilot, and whatever launches next month. Every other
|
|
34
|
+
methodology or skill framework maintains its own platform support matrix. By
|
|
35
|
+
building on the open-source skills CLI ecosystem, BMAD offloads the highest-churn
|
|
36
|
+
maintenance burden and focuses on what actually differentiates it: the methodology
|
|
37
|
+
itself.
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
**After** (distillate):
|
|
41
|
+
```
|
|
42
|
+
## Differentiation
|
|
43
|
+
- Anti-fragmentation positioning: BMAD = cross-platform constant across 40+ fragmenting AI tools; no competitor provides shared methodology layer
|
|
44
|
+
- Platform complexity delegated to Vercel skills CLI ecosystem (MIT); BMAD maintains methodology, not platform configs
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
### Technical Details to Compressed Facts
|
|
48
|
+
|
|
49
|
+
**Before** (discovery notes excerpt):
|
|
50
|
+
```
|
|
51
|
+
## Competitive Landscape
|
|
52
|
+
|
|
53
|
+
- **Vercel Skills.sh**: 83K+ skills, 18 agents, largest curated leaderboard —
|
|
54
|
+
but dev-only, skills trigger unreliably (20% without explicit prompting)
|
|
55
|
+
- **SkillsMP**: 400K+ skills directory, pure aggregator with no curation or CLI
|
|
56
|
+
- **ClawHub/OpenClaw**: ~3.2K curated skills with versioning/rollback, small ecosystem
|
|
57
|
+
- **Lindy**: No-code AI agent builder for business automation — closed platform,
|
|
58
|
+
no skill sharing
|
|
59
|
+
- **Microsoft Copilot Studio**: Enterprise no-code agent builder — vendor-locked
|
|
60
|
+
to Microsoft
|
|
61
|
+
- **MindStudio**: No-code AI agent platform — siloed, no interoperability
|
|
62
|
+
- **Make/Zapier AI**: Workflow automation adding AI agents — workflow-centric,
|
|
63
|
+
not methodology-centric
|
|
64
|
+
- **Key gap**: NO competitor combines structured methodology with plugin
|
|
65
|
+
marketplace — this is BMAD's whitespace
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
**After** (distillate):
|
|
69
|
+
```
|
|
70
|
+
## Competitive Landscape
|
|
71
|
+
- No competitor combines structured methodology + plugin marketplace (whitespace)
|
|
72
|
+
- Skills.sh (Vercel): 83K skills, 18 agents, dev-only, 20% trigger reliability
|
|
73
|
+
- SkillsMP: 400K skills, aggregator only, no curation/CLI
|
|
74
|
+
- ClawHub: 3.2K curated, versioning, small ecosystem
|
|
75
|
+
- No-code platforms (Lindy, Copilot Studio, MindStudio, Make/Zapier): closed/siloed, no skill portability, business-only
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
### Deduplication Across Documents
|
|
79
|
+
|
|
80
|
+
When the same fact appears in both a brief and discovery notes:
|
|
81
|
+
|
|
82
|
+
**Brief says:**
|
|
83
|
+
```
|
|
84
|
+
bmad-init must always be included as a base skill in every bundle
|
|
85
|
+
```
|
|
86
|
+
|
|
87
|
+
**Discovery notes say:**
|
|
88
|
+
```
|
|
89
|
+
bmad-init must always be included as a base skill in every bundle/install
|
|
90
|
+
(solves bootstrapping problem)
|
|
91
|
+
```
|
|
92
|
+
|
|
93
|
+
**Distillate keeps the more contextual version:**
|
|
94
|
+
```
|
|
95
|
+
- bmad-init: always included as base skill in every bundle (solves bootstrapping)
|
|
96
|
+
```
|
|
97
|
+
|
|
98
|
+
### Decision/Rationale Compression
|
|
99
|
+
|
|
100
|
+
**Before:**
|
|
101
|
+
```
|
|
102
|
+
We decided not to build our own platform support matrix going forward, instead
|
|
103
|
+
delegating to the Vercel skills CLI ecosystem. The rationale is that maintaining
|
|
104
|
+
20+ platform configs is the biggest maintenance burden and it's unsustainable
|
|
105
|
+
at 40+ platforms.
|
|
106
|
+
```
|
|
107
|
+
|
|
108
|
+
**After:**
|
|
109
|
+
```
|
|
110
|
+
- Rejected: own platform support matrix. Reason: unsustainable at 40+ platforms; delegate to Vercel CLI ecosystem
|
|
111
|
+
```
|
|
112
|
+
|
|
113
|
+
## Full Example
|
|
114
|
+
|
|
115
|
+
A complete distillate produced from a product brief and its discovery notes, targeted at PRD creation:
|
|
116
|
+
|
|
117
|
+
```markdown
|
|
118
|
+
---
|
|
119
|
+
type: bmad-distillate
|
|
120
|
+
sources:
|
|
121
|
+
- "product-brief-bmad-next-gen-installer.md"
|
|
122
|
+
- "product-brief-bmad-next-gen-installer-discovery-notes.md"
|
|
123
|
+
downstream_consumer: "PRD creation"
|
|
124
|
+
created: "2026-03-13"
|
|
125
|
+
token_estimate: 1450
|
|
126
|
+
parts: 1
|
|
127
|
+
---
|
|
128
|
+
|
|
129
|
+
## Core Concept
|
|
130
|
+
- BMAD Next-Gen Installer: replaces monolithic Node.js CLI with skill-based plugin architecture for distributing BMAD methodology across 40+ AI platforms
|
|
131
|
+
- Three layers: self-describing plugins (bmad-manifest.json), cross-platform install via Vercel skills CLI (MIT), runtime registration via bmad-init skill
|
|
132
|
+
- Transforms BMAD from dev-only methodology into open platform for any domain (creative, therapeutic, educational, personal)
|
|
133
|
+
|
|
134
|
+
## Problem
|
|
135
|
+
- Current installer maintains ~20 platform configs manually; each platform convention change requires installer update, test, release — largest maintenance burden on team
|
|
136
|
+
- Node.js/npm required — blocks non-technical users on UI-based platforms (Claude Co-Work, etc.)
|
|
137
|
+
- CSV manifests are static, generated once at install; no runtime scanning/registration
|
|
138
|
+
- Unsustainable at 40+ platforms; new tools launching weekly
|
|
139
|
+
|
|
140
|
+
## Solution Architecture
|
|
141
|
+
- Plugins: skill bundles with Anthropic plugin standard as base format + bmad-manifest.json extending for BMAD-specific metadata (installer options, capabilities, help integration, phase ordering, dependencies)
|
|
142
|
+
- Existing manifest example: `{"module-code":"bmm","replaces-skill":"bmad-create-product-brief","capabilities":[{"name":"create-brief","menu-code":"CB","supports-headless":true,"phase-name":"1-analysis","after":["brainstorming"],"before":["create-prd"],"is-required":true}]}`
|
|
143
|
+
- Vercel skills CLI handles platform translation; integration pattern (wrap/fork/call) is PRD decision
|
|
144
|
+
- bmad-init: global skill scanning installed bmad-manifest.json files, registering capabilities, configuring project settings; always included as base skill in every bundle (solves bootstrapping)
|
|
145
|
+
- bmad-update: plugin update path without full reinstall; technical approach (diff/replace/preserve customizations) is PRD decision
|
|
146
|
+
- Distribution tiers: (1) NPX installer wrapping skills CLI for technical users, (2) zip bundle + platform-specific README for non-technical users, (3) future marketplace
|
|
147
|
+
- Non-technical path has honest friction: "copy to right folder" requires knowing where; per-platform README instructions; improves over time as low-code space matures
|
|
148
|
+
|
|
149
|
+
## Differentiation
|
|
150
|
+
- Anti-fragmentation: BMAD = cross-platform constant; no competitor provides shared methodology layer across AI tools
|
|
151
|
+
- Curated quality: all submissions gated, human-reviewed by BMad + core team; 13.4% of community skills have critical vulnerabilities (Snyk 2026); quality gate value increases as ecosystem gets noisier
|
|
152
|
+
- Domain-agnostic: no competitor builds beyond software dev workflows; same plugin system powers any domain via BMAD Builder (separate initiative)
|
|
153
|
+
|
|
154
|
+
## Users (ordered by v1 priority)
|
|
155
|
+
- Module authors (primary v1): package/test/distribute plugins independently without installer changes
|
|
156
|
+
- Developers: single-command install on any of 40+ platforms via NPX
|
|
157
|
+
- Non-technical users: install without Node/Git/terminal; emerging segment including PMs, designers, educators
|
|
158
|
+
- Future plugin creators: non-dev authors using BMAD Builder; need distribution without building own installer
|
|
159
|
+
|
|
160
|
+
## Success Criteria
|
|
161
|
+
- Zero (or near-zero) custom platform directory code; delegated to skills CLI ecosystem
|
|
162
|
+
- Installation verified on top platforms by volume; skills CLI handles long tail
|
|
163
|
+
- Non-technical install path validated with non-developer users
|
|
164
|
+
- bmad-init discovers/registers all plugins from manifests; clear errors for malformed manifests
|
|
165
|
+
- At least one external module author successfully publishes plugin using manifest system
|
|
166
|
+
- bmad-update works without full reinstall
|
|
167
|
+
- Existing CLI users have documented migration path
|
|
168
|
+
|
|
169
|
+
## Scope
|
|
170
|
+
- In: manifest spec, bmad-init, bmad-update, Vercel CLI integration, NPX installer, zip bundles, migration path
|
|
171
|
+
- Out: BMAD Builder, marketplace web platform, skill conversion (prerequisite, separate), one-click install for all platforms, monetization, quality certification process (gated-submission principle is architectural requirement; process defined separately)
|
|
172
|
+
- Deferred: CI/CD integration, telemetry for module authors, air-gapped enterprise install, zip bundle integrity verification (checksums/signing), deeper non-technical platform integrations
|
|
173
|
+
|
|
174
|
+
## Current Installer (migration context)
|
|
175
|
+
- Entry: `tools/cli/bmad-cli.js` (Commander.js) → `tools/cli/installers/lib/core/installer.js`
|
|
176
|
+
- Platforms: `platform-codes.yaml` (~20 platforms with target dirs, legacy dirs, template types, special flags)
|
|
177
|
+
- Manifests: CSV files (skill/workflow/agent-manifest.csv) are current source of truth, not JSON
|
|
178
|
+
- External modules: `external-official-modules.yaml` (CIS, GDS, TEA, WDS) from npm with semver
|
|
179
|
+
- Dependencies: 4-pass resolver (collect → parse → resolve → transitive); YAML-declared only
|
|
180
|
+
- Config: prompts for name, communication language, document output language, output folder
|
|
181
|
+
- Skills already use directory-per-skill layout; bmad-manifest.json sidecars exist but are not source of truth
|
|
182
|
+
- Key shift: CSV-based static manifests → JSON-based runtime scanning
|
|
183
|
+
|
|
184
|
+
## Vercel Skills CLI
|
|
185
|
+
- `npx skills add <source>` — GitHub, GitLab, local paths, git URLs
|
|
186
|
+
- 40+ agents; per-agent path mappings; symlinks (recommended) or copies
|
|
187
|
+
- Scopes: project-level or global
|
|
188
|
+
- Discovery: `skills/`, `.agents/skills/`, agent-specific paths, `.claude-plugin/marketplace.json`
|
|
189
|
+
- Commands: add, list, find, remove, check, update, init
|
|
190
|
+
- Non-interactive: `-y`, `--all` flags for CI/CD
|
|
191
|
+
|
|
192
|
+
## Competitive Landscape
|
|
193
|
+
- No competitor combines structured methodology + plugin marketplace (whitespace)
|
|
194
|
+
- Skills.sh (Vercel): 83K skills, dev-only, 20% trigger reliability without explicit prompting
|
|
195
|
+
- SkillsMP: 400K skills, aggregator only, no curation
|
|
196
|
+
- ClawHub: 3.2K curated, versioning, small
|
|
197
|
+
- No-code platforms (Lindy, Copilot Studio, MindStudio, Make/Zapier): closed/siloed, no skill portability, business-only
|
|
198
|
+
- Market: $7.84B (2025) → $52.62B (2030); Agent Skills spec ~4 months old, 351K+ skills; standards converging under Linux Foundation AAIF (MCP, AGENTS.md, A2A)
|
|
199
|
+
|
|
200
|
+
## Rejected Alternatives
|
|
201
|
+
- Building own platform support matrix: unsustainable at 40+; delegate to Vercel ecosystem
|
|
202
|
+
- One-click install for non-technical v1: emerging space; guidance-based, improve over time
|
|
203
|
+
- Prior roadmap/brainstorming: clean start, unconstrained by previous planning
|
|
204
|
+
|
|
205
|
+
## Open Questions
|
|
206
|
+
- Vercel CLI integration pattern: wrap/fork/call/peer dependency?
|
|
207
|
+
- bmad-update mechanics: diff/replace? Preserve user customizations?
|
|
208
|
+
- Migration story: command/manual reinstall/compatibility shim?
|
|
209
|
+
- Cross-platform testing: CI matrix for top N? Community testing for rest?
|
|
210
|
+
- bmad-manifest.json as open standard submission to Agent Skills governance?
|
|
211
|
+
- Platforms NOT supported by Vercel skills CLI?
|
|
212
|
+
- Manifest versioning strategy for backward compatibility?
|
|
213
|
+
- Plugin author getting-started experience and tooling?
|
|
214
|
+
|
|
215
|
+
## Opportunities
|
|
216
|
+
- Module authors as acquisition channel: each published plugin distributes BMAD to creator's audience
|
|
217
|
+
- CI/CD integration: bmad-init as pipeline one-liner increases stickiness
|
|
218
|
+
- Educational institutions: structured methodology + non-technical install → university AI curriculum
|
|
219
|
+
- Skill composability: mixing BMAD modules with third-party skills for custom methodology stacks
|
|
220
|
+
|
|
221
|
+
## Risks
|
|
222
|
+
- Manifest format evolution creates versioning/compatibility burden once third-party authors publish
|
|
223
|
+
- Quality gate needs defined process, not just claim — gated review model addresses
|
|
224
|
+
- 40+ platform testing environments even with Vercel handling translation
|
|
225
|
+
- Scope creep pressure from marketplace vision (explicitly excluded but primary long-term value)
|
|
226
|
+
- Vercel dependency: minor supply-chain risk; MIT license allows fork if deprioritized
|
|
227
|
+
```
|
|
@@ -0,0 +1,78 @@
|
|
|
1
|
+
# Semantic Splitting Strategy
|
|
2
|
+
|
|
3
|
+
When the source content is large (exceeds ~15,000 tokens) or a token_budget requires it, split the distillate into semantically coherent sections rather than arbitrary size breaks.
|
|
4
|
+
|
|
5
|
+
## Why Semantic Over Size-Based
|
|
6
|
+
|
|
7
|
+
Arbitrary splits (every N tokens) break coherence. A downstream workflow loading "part 2 of 4" gets context fragments. Semantic splits produce self-contained topic clusters that a workflow can load selectively — "give me just the technical decisions section" — which is more useful and more token-efficient for the consumer.
|
|
8
|
+
|
|
9
|
+
## Splitting Process
|
|
10
|
+
|
|
11
|
+
### 1. Identify Natural Boundaries
|
|
12
|
+
|
|
13
|
+
After the initial extraction and deduplication (Steps 1-2 of the compression process), look for natural semantic boundaries:
|
|
14
|
+
- Distinct problem domains or functional areas
|
|
15
|
+
- Different stakeholder perspectives (users, technical, business)
|
|
16
|
+
- Temporal boundaries (current state vs future vision)
|
|
17
|
+
- Scope boundaries (in-scope vs out-of-scope vs deferred)
|
|
18
|
+
- Phase boundaries (analysis, design, implementation)
|
|
19
|
+
|
|
20
|
+
Choose boundaries that produce sections a downstream workflow might load independently.
|
|
21
|
+
|
|
22
|
+
### 2. Assign Items to Sections
|
|
23
|
+
|
|
24
|
+
For each extracted item, assign it to the most relevant section. Items that span multiple sections go in the root distillate.
|
|
25
|
+
|
|
26
|
+
Cross-cutting items (items relevant to multiple sections):
|
|
27
|
+
- Constraints that affect all areas → root distillate
|
|
28
|
+
- Decisions with broad impact → root distillate
|
|
29
|
+
- Section-specific decisions → section distillate
|
|
30
|
+
|
|
31
|
+
### 3. Produce Root Distillate
|
|
32
|
+
|
|
33
|
+
The root distillate contains:
|
|
34
|
+
- **Orientation** (3-5 bullets): what was distilled, from what sources, for what consumer, how many sections
|
|
35
|
+
- **Cross-references**: list of section distillates with 1-line descriptions
|
|
36
|
+
- **Cross-cutting items**: facts, decisions, and constraints that span multiple sections
|
|
37
|
+
- **Scope summary**: high-level in/out/deferred if applicable
|
|
38
|
+
|
|
39
|
+
### 4. Produce Section Distillates
|
|
40
|
+
|
|
41
|
+
Each section distillate must be self-sufficient — a reader loading only one section should understand it without the others.
|
|
42
|
+
|
|
43
|
+
Each section includes:
|
|
44
|
+
- **Context header** (1 line): "This section covers [topic]. Part N of M from [source document names]."
|
|
45
|
+
- **Section content**: thematically-grouped bullets following the same compression rules as a single distillate
|
|
46
|
+
- **Cross-references** (if needed): pointers to other sections for related content
|
|
47
|
+
|
|
48
|
+
### 5. Output Structure
|
|
49
|
+
|
|
50
|
+
Create a folder `{base-name}-distillate/` containing:
|
|
51
|
+
|
|
52
|
+
```
|
|
53
|
+
{base-name}-distillate/
|
|
54
|
+
├── _index.md # Root distillate: orientation, cross-cutting items, section manifest
|
|
55
|
+
├── 01-{topic-slug}.md # Self-contained section
|
|
56
|
+
├── 02-{topic-slug}.md
|
|
57
|
+
└── 03-{topic-slug}.md
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
Example:
|
|
61
|
+
```
|
|
62
|
+
product-brief-distillate/
|
|
63
|
+
├── _index.md
|
|
64
|
+
├── 01-problem-solution.md
|
|
65
|
+
├── 02-technical-decisions.md
|
|
66
|
+
└── 03-users-market.md
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
## Size Targets
|
|
70
|
+
|
|
71
|
+
When a token_budget is specified:
|
|
72
|
+
- Root distillate: ~20% of budget (orientation + cross-cutting items)
|
|
73
|
+
- Remaining budget split proportionally across sections based on content density
|
|
74
|
+
- If a section exceeds its proportional share, compress more aggressively or sub-split
|
|
75
|
+
|
|
76
|
+
When no token_budget but splitting is needed:
|
|
77
|
+
- Aim for sections of 3,000-5,000 tokens each
|
|
78
|
+
- Root distillate as small as possible while remaining useful standalone
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
type: skill
|
|
@@ -0,0 +1,81 @@
|
|
|
1
|
+
# Editorial Review - Prose
|
|
2
|
+
|
|
3
|
+
**Goal:** Review text for communication issues that impede comprehension and output suggested fixes in a three-column table.
|
|
4
|
+
|
|
5
|
+
**Your Role:** You are a clinical copy-editor: precise, professional, neither warm nor cynical. Apply Microsoft Writing Style Guide principles as your baseline. Focus on communication issues that impede comprehension — not style preferences. NEVER rewrite for preference — only fix genuine issues. Follow ALL steps in the STEPS section IN EXACT ORDER. DO NOT skip steps or change the sequence. HALT immediately when halt-conditions are met. Each action within a step is a REQUIRED action to complete that step.
|
|
6
|
+
|
|
7
|
+
**CONTENT IS SACROSANCT:** Never challenge ideas — only clarify how they're expressed.
|
|
8
|
+
|
|
9
|
+
**Inputs:**
|
|
10
|
+
- **content** (required) — Cohesive unit of text to review (markdown, plain text, or text-heavy XML)
|
|
11
|
+
- **style_guide** (optional) — Project-specific style guide. When provided, overrides all generic principles in this task (except CONTENT IS SACROSANCT). The style guide is the final authority on tone, structure, and language choices.
|
|
12
|
+
- **reader_type** (optional, default: `humans`) — `humans` for standard editorial, `llm` for precision focus
|
|
13
|
+
|
|
14
|
+
|
|
15
|
+
## PRINCIPLES
|
|
16
|
+
|
|
17
|
+
1. **Minimal intervention:** Apply the smallest fix that achieves clarity
|
|
18
|
+
2. **Preserve structure:** Fix prose within existing structure, never restructure
|
|
19
|
+
3. **Skip code/markup:** Detect and skip code blocks, frontmatter, structural markup
|
|
20
|
+
4. **When uncertain:** Flag with a query rather than suggesting a definitive change
|
|
21
|
+
5. **Deduplicate:** Same issue in multiple places = one entry with locations listed
|
|
22
|
+
6. **No conflicts:** Merge overlapping fixes into single entries
|
|
23
|
+
7. **Respect author voice:** Preserve intentional stylistic choices
|
|
24
|
+
|
|
25
|
+
> **STYLE GUIDE OVERRIDE:** If a style_guide input is provided, it overrides ALL generic principles in this task (including the Microsoft Writing Style Guide baseline and reader_type-specific priorities). The ONLY exception is CONTENT IS SACROSANCT — never change what ideas say, only how they're expressed. When style guide conflicts with this task, style guide wins.
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
## STEPS
|
|
29
|
+
|
|
30
|
+
### Step 1: Validate Input
|
|
31
|
+
|
|
32
|
+
- Check if content is empty or contains fewer than 3 words
|
|
33
|
+
- If empty or fewer than 3 words: **HALT** with error: "Content too short for editorial review (minimum 3 words required)"
|
|
34
|
+
- Validate reader_type is `humans` or `llm` (or not provided, defaulting to `humans`)
|
|
35
|
+
- If reader_type is invalid: **HALT** with error: "Invalid reader_type. Must be 'humans' or 'llm'"
|
|
36
|
+
- Identify content type (markdown, plain text, XML with text)
|
|
37
|
+
- Note any code blocks, frontmatter, or structural markup to skip
|
|
38
|
+
|
|
39
|
+
### Step 2: Analyze Style
|
|
40
|
+
|
|
41
|
+
- Analyze the style, tone, and voice of the input text
|
|
42
|
+
- Note any intentional stylistic choices to preserve (informal tone, technical jargon, rhetorical patterns)
|
|
43
|
+
- Calibrate review approach based on reader_type:
|
|
44
|
+
- If `llm`: Prioritize unambiguous references, consistent terminology, explicit structure, no hedging
|
|
45
|
+
- If `humans`: Prioritize clarity, flow, readability, natural progression
|
|
46
|
+
|
|
47
|
+
### Step 3: Editorial Review (CRITICAL)
|
|
48
|
+
|
|
49
|
+
- If style_guide provided: Consult style_guide now and note its key requirements — these override default principles for this review
|
|
50
|
+
- Review all prose sections (skip code blocks, frontmatter, structural markup)
|
|
51
|
+
- Identify communication issues that impede comprehension
|
|
52
|
+
- For each issue, determine the minimal fix that achieves clarity
|
|
53
|
+
- Deduplicate: If same issue appears multiple times, create one entry listing all locations
|
|
54
|
+
- Merge overlapping issues into single entries (no conflicting suggestions)
|
|
55
|
+
- For uncertain fixes, phrase as query: "Consider: [suggestion]?" rather than definitive change
|
|
56
|
+
- Preserve author voice — do not "improve" intentional stylistic choices
|
|
57
|
+
|
|
58
|
+
### Step 4: Output Results
|
|
59
|
+
|
|
60
|
+
- If issues found: Output a three-column markdown table with all suggested fixes
|
|
61
|
+
- If no issues found: Output "No editorial issues identified"
|
|
62
|
+
|
|
63
|
+
**Output format:**
|
|
64
|
+
|
|
65
|
+
| Original Text | Revised Text | Changes |
|
|
66
|
+
|---------------|--------------|---------|
|
|
67
|
+
| The exact original passage | The suggested revision | Brief explanation of what changed and why |
|
|
68
|
+
|
|
69
|
+
**Example:**
|
|
70
|
+
|
|
71
|
+
| Original Text | Revised Text | Changes |
|
|
72
|
+
|---------------|--------------|---------|
|
|
73
|
+
| The system will processes data and it handles errors. | The system processes data and handles errors. | Fixed subject-verb agreement ("will processes" to "processes"); removed redundant "it" |
|
|
74
|
+
| Users can chose from options (lines 12, 45, 78) | Users can choose from options | Fixed spelling: "chose" to "choose" (appears in 3 locations) |
|
|
75
|
+
|
|
76
|
+
|
|
77
|
+
## HALT CONDITIONS
|
|
78
|
+
|
|
79
|
+
- HALT with error if content is empty or fewer than 3 words
|
|
80
|
+
- HALT with error if reader_type is not `humans` or `llm`
|
|
81
|
+
- If no issues found after thorough review, output "No editorial issues identified" (this is valid completion, not an error)
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: bmad-editorial-review-structure
|
|
3
|
+
description: 'Structural editor that proposes cuts, reorganization, and simplification while preserving comprehension. Use when user requests structural review or editorial review of structure'
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
Follow the instructions in ./workflow.md.
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
type: skill
|