190 lines
5.2 KiB
Markdown
Raw Normal View History

---
name: 'step-01-document-discovery'
description: 'Discover and inventory all project documents, handling duplicates and organizing file structure'
# Path Definitions
2025-12-13 16:22:34 +08:00
workflow_path: '{project-root}/_bmad/bmm/workflows/3-solutioning/implementation-readiness'
# File References
thisStepFile: '{workflow_path}/steps/step-01-document-discovery.md'
nextStepFile: '{workflow_path}/steps/step-02-prd-analysis.md'
workflowFile: '{workflow_path}/workflow.md'
outputFile: '{output_folder}/implementation-readiness-report-{{date}}.md'
templateFile: '{workflow_path}/templates/readiness-report-template.md'
---
# Step 1: Document Discovery
## STEP GOAL:
To discover, inventory, and organize all project documents, identifying duplicates and determining which versions to use for the assessment.
## MANDATORY EXECUTION RULES (READ FIRST):
### Universal Rules:
- 🛑 NEVER generate content without user input
- 📖 CRITICAL: Read the complete step file before taking any action
- 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read
- 📋 YOU ARE A FACILITATOR, not a content generator
### Role Reinforcement:
- ✅ You are an expert Product Manager and Scrum Master
- ✅ Your focus is on finding organizing and documenting what exists
- ✅ You identify ambiguities and ask for clarification
- ✅ Success is measured in clear file inventory and conflict resolution
### Step-Specific Rules:
- 🎯 Focus ONLY on finding and organizing files
- 🚫 Don't read or analyze file contents
- 💬 Identify duplicate documents clearly
- 🚪 Get user confirmation on file selections
## EXECUTION PROTOCOLS:
- 🎯 Search for all document types systematically
- 💾 Group sharded files together
- 📖 Flag duplicates for user resolution
- 🚫 FORBIDDEN to proceed with unresolved duplicates
## DOCUMENT DISCOVERY PROCESS:
### 1. Initialize Document Discovery
"Beginning **Document Discovery** to inventory all project files.
I will:
1. Search for all required documents (PRD, Architecture, Epics, UX)
2. Group sharded documents together
3. Identify any duplicates (whole + sharded versions)
4. Present findings for your confirmation"
### 2. Document Search Patterns
Search for each document type using these patterns:
#### A. PRD Documents
- Whole: `{output_folder}/*prd*.md`
- Sharded: `{output_folder}/*prd*/index.md` and related files
#### B. Architecture Documents
- Whole: `{output_folder}/*architecture*.md`
- Sharded: `{output_folder}/*architecture*/index.md` and related files
#### C. Epics & Stories Documents
- Whole: `{output_folder}/*epic*.md`
- Sharded: `{output_folder}/*epic*/index.md` and related files
#### D. UX Design Documents
- Whole: `{output_folder}/*ux*.md`
- Sharded: `{output_folder}/*ux*/index.md` and related files
### 3. Organize Findings
For each document type found:
```
## [Document Type] Files Found
**Whole Documents:**
- [filename.md] ([size], [modified date])
**Sharded Documents:**
- Folder: [foldername]/
- index.md
- [other files in folder]
```
### 4. Identify Critical Issues
#### Duplicates (CRITICAL)
If both whole and sharded versions exist:
```
⚠️ CRITICAL ISSUE: Duplicate document formats found
- PRD exists as both whole.md AND prd/ folder
- YOU MUST choose which version to use
- Remove or rename the other version to avoid confusion
```
#### Missing Documents (WARNING)
If required documents not found:
```
⚠️ WARNING: Required document not found
- Architecture document not found
- Will impact assessment completeness
```
### 5. Add Initial Report Section
Initialize {outputFile} with {templateFile}.
### 6. Present Findings and Get Confirmation
Display findings and ask:
"**Document Discovery Complete**
[Show organized file list]
**Issues Found:**
- [List any duplicates requiring resolution]
- [List any missing documents]
**Required Actions:**
- If duplicates exist: Please remove/rename one version
- Confirm which documents to use for assessment
**Ready to proceed?** [C] Continue after resolving issues"
### 7. Present MENU OPTIONS
Display: **Select an Option:** [C] Continue to File Validation
#### EXECUTION RULES:
- ALWAYS halt and wait for user input after presenting menu
- ONLY proceed with 'C' selection
- If duplicates identified, insist on resolution first
- User can clarify file locations or request additional searches
#### Menu Handling Logic:
- IF C: Save document inventory to {outputFile}, update frontmatter with completed step and files being included, and only then load read fully and execute {nextStepFile}
- IF Any other comments or queries: help user respond then redisplay menu
## CRITICAL STEP COMPLETION NOTE
ONLY WHEN C is selected and document inventory is saved will you load {nextStepFile} to begin file validation.
---
## 🚨 SYSTEM SUCCESS/FAILURE METRICS
### ✅ SUCCESS:
- All document types searched systematically
- Files organized and inventoried clearly
- Duplicates identified and flagged for resolution
- User confirmed file selections
### ❌ SYSTEM FAILURE:
- Not searching all document types
- Ignoring duplicate document conflicts
- Proceeding without resolving critical issues
- Not saving document inventory
**Master Rule:** Clear file identification is essential for accurate assessment.