doc status updates
This commit is contained in:
Brian Madison
@@ -1,53 +0,0 @@
|
||||
# Project Workflow Analysis
|
||||
|
||||
**Date:** {{date}}
|
||||
**Project:** {{project_name}}
|
||||
**Analyst:** {{user_name}}
|
||||
|
||||
## Assessment Results
|
||||
|
||||
### Project Classification
|
||||
|
||||
- **Project Type:** {{project_type}}
|
||||
- **Project Level:** {{project_level}}
|
||||
- **Instruction Set:** {{instruction_set}}
|
||||
|
||||
### Scope Summary
|
||||
|
||||
- **Brief Description:** {{scope_description}}
|
||||
- **Estimated Stories:** {{story_count}}
|
||||
- **Estimated Epics:** {{epic_count}}
|
||||
- **Timeline:** {{timeline}}
|
||||
|
||||
### Context
|
||||
|
||||
- **Greenfield/Brownfield:** {{field_type}}
|
||||
- **Existing Documentation:** {{existing_docs}}
|
||||
- **Team Size:** {{team_size}}
|
||||
- **Deployment Intent:** {{deployment_intent}}
|
||||
|
||||
## Recommended Workflow Path
|
||||
|
||||
### Primary Outputs
|
||||
|
||||
{{expected_outputs}}
|
||||
|
||||
### Workflow Sequence
|
||||
|
||||
{{workflow_steps}}
|
||||
|
||||
### Next Actions
|
||||
|
||||
{{next_steps}}
|
||||
|
||||
## Special Considerations
|
||||
|
||||
{{special_notes}}
|
||||
|
||||
## Technical Preferences Captured
|
||||
|
||||
{{technical_preferences}}
|
||||
|
||||
---
|
||||
|
||||
_This analysis serves as the routing decision for the adaptive PRD workflow and will be referenced by future orchestration workflows._
|
||||
@@ -1,18 +0,0 @@
|
||||
# {{project_name}} - Epic Breakdown
|
||||
|
||||
**Author:** {{user_name}}
|
||||
**Date:** {{date}}
|
||||
**Project Level:** {{project_level}}
|
||||
**Target Scale:** {{target_scale}}
|
||||
|
||||
---
|
||||
|
||||
## Epic Overview
|
||||
|
||||
{{epic_overview}}
|
||||
|
||||
---
|
||||
|
||||
## Epic Details
|
||||
|
||||
{{epic_details}}
|
||||
@@ -1,267 +0,0 @@
|
||||
# PRD Workflow - Large Projects (Level 3-4)
|
||||
|
||||
<workflow>
|
||||
|
||||
<critical>The workflow execution engine is governed by: {project_root}/bmad/core/tasks/workflow.xml</critical>
|
||||
<critical>You MUST have already loaded and processed: {installed_path}/workflow.yaml</critical>
|
||||
<critical>This is the LARGE instruction set for Level 3-4 projects - full PRD + architect handoff</critical>
|
||||
<critical>Project analysis already completed - proceeding with comprehensive requirements</critical>
|
||||
<critical>NO TECH-SPEC - architecture handled by specialist workflow</critical>
|
||||
<critical>Uses prd_template for PRD output, epics_template for epics output</critical>
|
||||
<critical>If users mention technical details, append to technical_preferences with timestamp</critical>
|
||||
|
||||
<step n="1" goal="Load context and handle continuation">
|
||||
|
||||
<action>Load project-workflow-analysis.md</action>
|
||||
<action>Confirm Level 3-4 - Full product or platform</action>
|
||||
|
||||
<check>If continuation_mode == true:</check>
|
||||
<action>Load existing PRD.md and check completion status</action>
|
||||
<ask>Found existing work. Would you like to:
|
||||
|
||||
1. Review what's done and continue
|
||||
2. Modify existing sections
|
||||
3. Start fresh
|
||||
</ask>
|
||||
<action>If continuing, skip to first incomplete section</action>
|
||||
|
||||
<check>If new or starting fresh:</check>
|
||||
Check `output_folder` for `product_brief`, `market_research`, and other docs.
|
||||
|
||||
<critical>For Level 3-4, Product Brief is STRONGLY recommended</critical>
|
||||
|
||||
<action>Load prd_template from workflow.yaml</action>
|
||||
|
||||
Get comprehensive description of the project vision.
|
||||
|
||||
<template-output>description</template-output>
|
||||
|
||||
</step>
|
||||
|
||||
<step n="2" goal="Define deployment intent and strategic goals">
|
||||
|
||||
<ask>What is the deployment intent?
|
||||
|
||||
- MVP for early users
|
||||
- Production SaaS/application
|
||||
- Enterprise system
|
||||
- Platform/ecosystem
|
||||
</ask>
|
||||
|
||||
<template-output>deployment_intent</template-output>
|
||||
|
||||
**Goal Guidelines**:
|
||||
|
||||
- Level 3: 3-5 strategic goals
|
||||
- Level 4: 5-7 strategic goals
|
||||
|
||||
Each goal should be measurable and outcome-focused.
|
||||
|
||||
<template-output>goals</template-output>
|
||||
|
||||
</step>
|
||||
|
||||
<step n="3" goal="Comprehensive context">
|
||||
|
||||
1-2 paragraphs on problem, current situation, why now.
|
||||
|
||||
<template-output>context</template-output>
|
||||
<elicit-required/>
|
||||
|
||||
</step>
|
||||
|
||||
<step n="4" goal="Comprehensive functional requirements">
|
||||
|
||||
**FR Guidelines**:
|
||||
|
||||
- Level 3: 12-20 FRs
|
||||
- Level 4: 20-30 FRs
|
||||
|
||||
Group related features logically.
|
||||
|
||||
<template-output>functional_requirements</template-output>
|
||||
<elicit-required/>
|
||||
|
||||
</step>
|
||||
|
||||
<step n="5" goal="Comprehensive non-functional requirements">
|
||||
|
||||
Match NFRs to deployment intent (8-12 NFRs)
|
||||
|
||||
<template-output>non_functional_requirements</template-output>
|
||||
|
||||
</step>
|
||||
|
||||
<step n="6" goal="Detailed user journeys">
|
||||
|
||||
**Journey Requirements**:
|
||||
|
||||
- Level 3: 2-3 detailed journeys
|
||||
- Level 4: 3-5 comprehensive journeys
|
||||
|
||||
Map complete user flows with decision points.
|
||||
|
||||
<template-output>user_journeys</template-output>
|
||||
<elicit-required/>
|
||||
|
||||
</step>
|
||||
|
||||
<step n="7" goal="Comprehensive UX principles">
|
||||
|
||||
8-10 UX principles guiding all interface decisions.
|
||||
|
||||
<template-output>ux_principles</template-output>
|
||||
|
||||
</step>
|
||||
|
||||
<step n="8" goal="Epic structure for phased delivery">
|
||||
|
||||
**Epic Guidelines**:
|
||||
|
||||
- Level 3: 2-5 epics (12-40 stories)
|
||||
- Level 4: 5+ epics (40+ stories)
|
||||
|
||||
Each epic delivers significant value.
|
||||
|
||||
<template-output>epics</template-output>
|
||||
<elicit-required/>
|
||||
|
||||
</step>
|
||||
|
||||
<step n="9" goal="Generate detailed epic breakdown in epics.md">
|
||||
|
||||
<action>Load epics_template from workflow.yaml</action>
|
||||
|
||||
<critical>Create separate epics.md with full story hierarchy</critical>
|
||||
|
||||
<template-output file="epics.md">epic_overview</template-output>
|
||||
|
||||
<for-each epic="epic_list">
|
||||
|
||||
Generate Epic {{epic_number}} with expanded goals, capabilities, success criteria.
|
||||
|
||||
Generate all stories with:
|
||||
|
||||
- User story format
|
||||
- Prerequisites
|
||||
- Acceptance criteria (3-8 per story)
|
||||
- Technical notes (high-level only)
|
||||
|
||||
<template-output file="epics.md">epic\_{{epic_number}}\_details</template-output>
|
||||
<elicit-required/>
|
||||
|
||||
</for-each>
|
||||
|
||||
</step>
|
||||
|
||||
<step n="10" goal="Document out of scope">
|
||||
|
||||
List features/ideas preserved for future phases.
|
||||
|
||||
<template-output>out_of_scope</template-output>
|
||||
|
||||
</step>
|
||||
|
||||
<step n="11" goal="Document assumptions and dependencies">
|
||||
|
||||
Only document ACTUAL assumptions from discussion.
|
||||
|
||||
<template-output>assumptions_and_dependencies</template-output>
|
||||
|
||||
</step>
|
||||
|
||||
<step n="12" goal="Generate architect handoff and next steps checklist">
|
||||
|
||||
## Next Steps for {{project_name}}
|
||||
|
||||
Since this is a Level {{project_level}} project, you need architecture before stories.
|
||||
|
||||
**Start new chat with architect and provide:**
|
||||
|
||||
1. This PRD: `{{default_output_file}}`
|
||||
2. Epic structure: `{{epics_output_file}}`
|
||||
3. Input documents: {{input_documents}}
|
||||
|
||||
**Ask architect to:**
|
||||
|
||||
- Run `architecture` workflow
|
||||
- Consider reference architectures
|
||||
- Generate solution fragments
|
||||
- Create architecture.md
|
||||
|
||||
## Complete Next Steps Checklist
|
||||
|
||||
<action>Generate comprehensive checklist based on project analysis</action>
|
||||
|
||||
### Phase 1: Architecture and Design
|
||||
|
||||
- [ ] **Run architecture workflow** (REQUIRED)
|
||||
- Command: `workflow architecture`
|
||||
- Input: PRD.md, epics.md
|
||||
- Output: architecture.md
|
||||
|
||||
<check>If project has significant UX/UI components (Level 3-4 typically does):</check>
|
||||
|
||||
- [ ] **Run UX specification workflow** (HIGHLY RECOMMENDED for user-facing systems)
|
||||
- Command: `workflow plan-project` then select "UX specification"
|
||||
- Or continue within this workflow if UI-heavy
|
||||
- Input: PRD.md, epics.md, architecture.md (once available)
|
||||
- Output: ux-specification.md
|
||||
- Optional: AI Frontend Prompt for rapid prototyping
|
||||
- Note: Creates comprehensive UX/UI spec including IA, user flows, components
|
||||
|
||||
### Phase 2: Detailed Planning
|
||||
|
||||
- [ ] **Generate detailed user stories**
|
||||
- Command: `workflow generate-stories`
|
||||
- Input: epics.md + architecture.md
|
||||
- Output: user-stories.md with full acceptance criteria
|
||||
|
||||
- [ ] **Create technical design documents**
|
||||
- Database schema
|
||||
- API specifications
|
||||
- Integration points
|
||||
|
||||
- [ ] **Define testing strategy**
|
||||
- Unit test approach
|
||||
- Integration test plan
|
||||
- UAT criteria
|
||||
|
||||
### Phase 3: Development Preparation
|
||||
|
||||
- [ ] **Set up development environment**
|
||||
- Repository structure
|
||||
- CI/CD pipeline
|
||||
- Development tools
|
||||
|
||||
- [ ] **Create sprint plan**
|
||||
- Story prioritization
|
||||
- Sprint boundaries
|
||||
- Resource allocation
|
||||
|
||||
- [ ] **Establish monitoring and metrics**
|
||||
- Success metrics from PRD
|
||||
- Technical monitoring
|
||||
- User analytics
|
||||
|
||||
<ask>Project Planning Complete! Next immediate action:
|
||||
|
||||
1. Start architecture workflow
|
||||
2. Create UX specification (if UI-heavy project)
|
||||
3. Generate AI Frontend Prompt (if UX complete)
|
||||
4. Review all outputs with stakeholders
|
||||
5. Begin detailed story generation
|
||||
6. Exit workflow
|
||||
|
||||
Which would you like to proceed with?</ask>
|
||||
|
||||
<check>If user selects option 2:</check>
|
||||
<action>LOAD: {installed_path}/ux/instructions-ux.md</action>
|
||||
<action>Pass mode="integrated" with Level 3-4 context</action>
|
||||
|
||||
<check>If user selects option 3:</check>
|
||||
<invoke-task>{project-root}/bmad/bmm/tasks/ai-fe-prompt.md</invoke-task>
|
||||
|
||||
</step>
|
||||
|
||||
</workflow>
|
||||
@@ -1,251 +0,0 @@
|
||||
# PRD Workflow - Medium Projects (Level 1-2)
|
||||
|
||||
<workflow>
|
||||
|
||||
<critical>The workflow execution engine is governed by: {project_root}/bmad/core/tasks/workflow.xml</critical>
|
||||
<critical>You MUST have already loaded and processed: {installed_path}/workflow.yaml</critical>
|
||||
<critical>This is the MEDIUM instruction set for Level 1-2 projects - minimal PRD + solutioning handoff</critical>
|
||||
<critical>Project analysis already completed - proceeding with focused requirements</critical>
|
||||
<critical>Uses prd_template for PRD output, epics_template for epics output</critical>
|
||||
<critical>NO TECH-SPEC - solutioning handled by specialist workflow</critical>
|
||||
<critical>If users mention technical details, append to technical_preferences with timestamp</critical>
|
||||
|
||||
<step n="1" goal="Load context and handle continuation">
|
||||
|
||||
<action>Load project-workflow-analysis.md</action>
|
||||
<action>Confirm Level 1-2 - Feature or small system</action>
|
||||
|
||||
<check>If continuation_mode == true:</check>
|
||||
<action>Load existing PRD.md and check completion status</action>
|
||||
<ask>Found existing work. Would you like to:
|
||||
|
||||
1. Review what's done and continue
|
||||
2. Modify existing sections
|
||||
3. Start fresh
|
||||
</ask>
|
||||
<action>If continuing, skip to first incomplete section</action>
|
||||
|
||||
<check>If new or starting fresh:</check>
|
||||
Check `output_folder` for existing docs. Ask user if they have a Product Brief.
|
||||
|
||||
<action>Load prd_template from workflow.yaml</action>
|
||||
|
||||
<critical>Get the core idea of what they're building</critical>
|
||||
|
||||
<template-output>description</template-output>
|
||||
|
||||
</step>
|
||||
|
||||
<step n="2" goal="Define deployment intent and goals">
|
||||
|
||||
<ask>What is the deployment intent?
|
||||
|
||||
- Demo/POC
|
||||
- MVP for early users
|
||||
- Production app
|
||||
</ask>
|
||||
|
||||
<template-output>deployment_intent</template-output>
|
||||
|
||||
**Goal Guidelines**:
|
||||
|
||||
- Level 1: 1-2 primary goals
|
||||
- Level 2: 2-3 primary goals
|
||||
|
||||
<template-output>goals</template-output>
|
||||
|
||||
</step>
|
||||
|
||||
<step n="3" goal="Brief context">
|
||||
|
||||
**Keep it brief**: 1 paragraph on why this matters now.
|
||||
|
||||
<template-output>context</template-output>
|
||||
|
||||
</step>
|
||||
|
||||
<step n="4" goal="Functional requirements - focused set">
|
||||
|
||||
**FR Guidelines**:
|
||||
|
||||
- Level 1: 3-8 FRs
|
||||
- Level 2: 8-15 FRs
|
||||
|
||||
**Format**: `FR001: [user capability]`
|
||||
|
||||
<template-output>functional_requirements</template-output>
|
||||
<elicit-required/>
|
||||
|
||||
</step>
|
||||
|
||||
<step n="5" goal="Non-functional requirements - essentials only">
|
||||
|
||||
Focus on critical NFRs only (3-5 max)
|
||||
|
||||
<template-output>non_functional_requirements</template-output>
|
||||
|
||||
</step>
|
||||
|
||||
<step n="6" goal="Simple user journey" if="level >= 2">
|
||||
|
||||
- Level 2: 1 simple user journey for primary use case
|
||||
|
||||
<template-output>user_journeys</template-output>
|
||||
|
||||
</step>
|
||||
|
||||
<step n="7" goal="Basic UX principles" optional="true">
|
||||
|
||||
3-5 key UX principles if relevant
|
||||
|
||||
<template-output>ux_principles</template-output>
|
||||
|
||||
</step>
|
||||
|
||||
<step n="8" goal="Simple epic structure">
|
||||
|
||||
**Epic Guidelines**:
|
||||
|
||||
- Level 1: 1 epic with 1-10 stories
|
||||
- Level 2: 1-2 epics with 5-15 stories total
|
||||
|
||||
Create simple epic list with story titles.
|
||||
|
||||
<template-output>epics</template-output>
|
||||
|
||||
<action>Load epics_template from workflow.yaml</action>
|
||||
|
||||
Generate epic-stories.md with basic story structure.
|
||||
|
||||
<template-output file="epic-stories.md">epic_stories</template-output>
|
||||
<elicit-required/>
|
||||
|
||||
</step>
|
||||
|
||||
<step n="9" goal="Document out of scope" optional="true">
|
||||
|
||||
List features/ideas preserved for future phases.
|
||||
|
||||
<template-output>out_of_scope</template-output>
|
||||
|
||||
</step>
|
||||
|
||||
<step n="10" goal="Document assumptions and dependencies" optional="true">
|
||||
|
||||
Only document ACTUAL assumptions from discussion.
|
||||
|
||||
<template-output>assumptions_and_dependencies</template-output>
|
||||
|
||||
</step>
|
||||
|
||||
<step n="11" goal="Validate cohesion" optional="true">
|
||||
|
||||
<action>Offer to run cohesion validation</action>
|
||||
|
||||
<ask>Planning complete! Before proceeding to next steps, would you like to validate project cohesion?
|
||||
|
||||
**Cohesion Validation** checks:
|
||||
|
||||
- PRD-Tech Spec alignment
|
||||
- Feature sequencing and dependencies
|
||||
- Infrastructure setup order (greenfield)
|
||||
- Integration risks and rollback plans (brownfield)
|
||||
- External dependencies properly planned
|
||||
- UI/UX considerations (if applicable)
|
||||
|
||||
Run cohesion validation? (y/n)</ask>
|
||||
|
||||
<check>If yes:</check>
|
||||
<action>Load {installed_path}/checklist.md</action>
|
||||
<action>Review all outputs against "Cohesion Validation (All Levels)" section</action>
|
||||
<action>Validate PRD sections, then cohesion sections A-H as applicable</action>
|
||||
<action>Apply Section B (Greenfield) or Section C (Brownfield) based on field_type</action>
|
||||
<action>Include Section E (UI/UX) if UI components exist</action>
|
||||
<action>Generate comprehensive validation report with findings</action>
|
||||
|
||||
</step>
|
||||
|
||||
<step n="12" goal="Generate solutioning handoff and next steps checklist">
|
||||
|
||||
## Next Steps for {{project_name}}
|
||||
|
||||
Since this is a Level {{project_level}} project, you need solutioning before implementation.
|
||||
|
||||
**Start new chat with solutioning workflow and provide:**
|
||||
|
||||
1. This PRD: `{{default_output_file}}`
|
||||
2. Epic structure: `{{epics_output_file}}`
|
||||
3. Input documents: {{input_documents}}
|
||||
|
||||
**Ask solutioning workflow to:**
|
||||
|
||||
- Run `3-solutioning` workflow
|
||||
- Generate solution-architecture.md
|
||||
- Create per-epic tech specs
|
||||
|
||||
## Complete Next Steps Checklist
|
||||
|
||||
<action>Generate comprehensive checklist based on project analysis</action>
|
||||
|
||||
### Phase 1: Solution Architecture and Design
|
||||
|
||||
- [ ] **Run solutioning workflow** (REQUIRED)
|
||||
- Command: `workflow solution-architecture`
|
||||
- Input: PRD.md, epic-stories.md
|
||||
- Output: solution-architecture.md, tech-spec-epic-N.md files
|
||||
|
||||
<check>If project has significant UX/UI components (Level 1-2 with UI):</check>
|
||||
|
||||
- [ ] **Run UX specification workflow** (HIGHLY RECOMMENDED for user-facing systems)
|
||||
- Command: `workflow plan-project` then select "UX specification"
|
||||
- Or continue within this workflow if UI-heavy
|
||||
- Input: PRD.md, epic-stories.md, solution-architecture.md (once available)
|
||||
- Output: ux-specification.md
|
||||
- Optional: AI Frontend Prompt for rapid prototyping
|
||||
- Note: Creates comprehensive UX/UI spec including IA, user flows, components
|
||||
|
||||
### Phase 2: Detailed Planning
|
||||
|
||||
- [ ] **Generate detailed user stories**
|
||||
- Command: `workflow generate-stories`
|
||||
- Input: epic-stories.md + solution-architecture.md
|
||||
- Output: user-stories.md with full acceptance criteria
|
||||
|
||||
- [ ] **Create technical design documents**
|
||||
- Database schema
|
||||
- API specifications
|
||||
- Integration points
|
||||
|
||||
### Phase 3: Development Preparation
|
||||
|
||||
- [ ] **Set up development environment**
|
||||
- Repository structure
|
||||
- CI/CD pipeline
|
||||
- Development tools
|
||||
|
||||
- [ ] **Create sprint plan**
|
||||
- Story prioritization
|
||||
- Sprint boundaries
|
||||
- Resource allocation
|
||||
|
||||
<ask>Project Planning Complete! Next immediate action:
|
||||
|
||||
1. Start solutioning workflow
|
||||
2. Create UX specification (if UI-heavy project)
|
||||
3. Generate AI Frontend Prompt (if UX complete)
|
||||
4. Review all outputs with stakeholders
|
||||
5. Begin detailed story generation
|
||||
6. Exit workflow
|
||||
|
||||
Which would you like to proceed with?</ask>
|
||||
|
||||
<check>If user selects option 2:</check>
|
||||
<action>LOAD: {installed_path}/ux/instructions-ux.md</action>
|
||||
<action>Pass mode="integrated" with Level 1-2 context</action>
|
||||
|
||||
<check>If user selects option 3:</check>
|
||||
<invoke-task>{project-root}/bmad/bmm/tasks/ai-fe-prompt.md</invoke-task>
|
||||
|
||||
</step>
|
||||
|
||||
</workflow>
|
||||
@@ -1,73 +0,0 @@
|
||||
# {{project_name}} Product Requirements Document (PRD)
|
||||
|
||||
**Author:** {{user_name}}
|
||||
**Date:** {{date}}
|
||||
**Project Level:** {{project_level}}
|
||||
**Project Type:** {{project_type}}
|
||||
**Target Scale:** {{target_scale}}
|
||||
|
||||
---
|
||||
|
||||
## Description, Context and Goals
|
||||
|
||||
{{description}}
|
||||
|
||||
### Deployment Intent
|
||||
|
||||
{{deployment_intent}}
|
||||
|
||||
### Context
|
||||
|
||||
{{context}}
|
||||
|
||||
### Goals
|
||||
|
||||
{{goals}}
|
||||
|
||||
## Requirements
|
||||
|
||||
### Functional Requirements
|
||||
|
||||
{{functional_requirements}}
|
||||
|
||||
### Non-Functional Requirements
|
||||
|
||||
{{non_functional_requirements}}
|
||||
|
||||
## User Journeys
|
||||
|
||||
{{user_journeys}}
|
||||
|
||||
## UX Design Principles
|
||||
|
||||
{{ux_principles}}
|
||||
|
||||
## Epics
|
||||
|
||||
{{epics}}
|
||||
|
||||
{{epic_note}}
|
||||
|
||||
## Out of Scope
|
||||
|
||||
{{out_of_scope}}
|
||||
|
||||
---
|
||||
|
||||
## Next Steps
|
||||
|
||||
{{next_steps}}
|
||||
|
||||
## Document Status
|
||||
|
||||
- [ ] Goals and context validated with stakeholders
|
||||
- [ ] All functional requirements reviewed
|
||||
- [ ] User journeys cover all major personas
|
||||
- [ ] Epic structure approved for phased delivery
|
||||
- [ ] Ready for architecture phase
|
||||
|
||||
_Note: See technical-decisions.md for captured technical context_
|
||||
|
||||
---
|
||||
|
||||
_This PRD adapts to project level {{project_level}} - providing appropriate detail without overburden._
|
||||
Reference in New Issue
Block a user