You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221
  1. # Step 11: Document Polish
  2. **Progress: Step 11 of 12** - Next: Complete PRD
  3. ## MANDATORY EXECUTION RULES (READ FIRST):
  4. - 🛑 CRITICAL: Load the ENTIRE document before making changes
  5. - 📖 CRITICAL: Read complete step file before taking action
  6. - 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read
  7. - ✅ This is a POLISH step - optimize existing content
  8. - 📋 IMPROVE flow, coherence, and readability
  9. - 💬 PRESERVE user's voice and intent
  10. - 🎯 MAINTAIN all essential information while improving presentation
  11. - ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
  12. - ✅ YOU MUST ALWAYS WRITE all artifact and document content in `{document_output_language}`
  13. ## EXECUTION PROTOCOLS:
  14. - 🎯 Load complete document first
  15. - 📝 Review for flow and coherence issues
  16. - ✂️ Reduce duplication while preserving essential info
  17. - 📖 Ensure proper ## Level 2 headers throughout
  18. - 💾 Save optimized document
  19. - ⚠️ Present A/P/C menu after polish
  20. - 🚫 DO NOT skip review steps
  21. ## CONTEXT BOUNDARIES:
  22. - Complete PRD document exists from all previous steps
  23. - Document may have duplication from progressive append
  24. - Sections may not flow smoothly together
  25. - Level 2 headers ensure document can be split if needed
  26. - Focus on readability and coherence
  27. ## YOUR TASK:
  28. Optimize the complete PRD document for flow, coherence, and professional presentation while preserving all essential information.
  29. ## DOCUMENT POLISH SEQUENCE:
  30. ### 1. Load Context and Document
  31. **CRITICAL:** Load the PRD purpose document first:
  32. - Read `../data/prd-purpose.md` to understand what makes a great BMAD PRD
  33. - Internalize the philosophy: information density, traceability, measurable requirements
  34. - Keep the dual-audience nature (humans + LLMs) in mind
  35. **Then Load the PRD Document:**
  36. - Read `{outputFile}` completely from start to finish
  37. - Understand the full document structure and content
  38. - Identify all sections and their relationships
  39. - Note areas that need attention
  40. ### 2. Document Quality Review
  41. Review the entire document with PRD purpose principles in mind:
  42. **Information Density:**
  43. - Are there wordy phrases that can be condensed?
  44. - Is conversational padding present?
  45. - Can sentences be more direct and concise?
  46. **Flow and Coherence:**
  47. - Do sections transition smoothly?
  48. - Are there jarring topic shifts?
  49. - Does the document tell a cohesive story?
  50. - Is the progression logical for readers?
  51. **Duplication Detection:**
  52. - Are ideas repeated across sections?
  53. - Is the same information stated multiple times?
  54. - Can redundant content be consolidated?
  55. - Are there contradictory statements?
  56. **Header Structure:**
  57. - Are all main sections using ## Level 2 headers?
  58. - Is the hierarchy consistent (##, ###, ####)?
  59. - Can sections be easily extracted or referenced?
  60. - Are headers descriptive and clear?
  61. **Readability:**
  62. - Are sentences clear and concise?
  63. - Is the language consistent throughout?
  64. - Are technical terms used appropriately?
  65. - Would stakeholders find this easy to understand?
  66. ### 2b. Brainstorming Reconciliation (if brainstorming input exists)
  67. **Check the PRD frontmatter `inputDocuments` for any brainstorming document** (e.g., `brainstorming-session*.md`, `brainstorming-report.md`). If a brainstorming document was used as input:
  68. 1. **Load the brainstorming document** and extract all distinct ideas, themes, and recommendations
  69. 2. **Cross-reference against the PRD** — for each brainstorming idea, check if it landed in any PRD section (requirements, success criteria, user journeys, scope, etc.)
  70. 3. **Identify dropped ideas** — ideas from brainstorming that do not appear anywhere in the PRD. Pay special attention to:
  71. - Tone, personality, and interaction design ideas (these are most commonly lost)
  72. - Design philosophy and coaching approach ideas
  73. - "What should this feel like" ideas (UX feel, not just UX function)
  74. - Qualitative/soft ideas that don't map cleanly to functional requirements
  75. 4. **Present findings to user**: "These brainstorming ideas did not make it into the PRD: [list]. Should any be incorporated?"
  76. 5. **If user wants to incorporate dropped ideas**: Add them to the most appropriate PRD section (success criteria, non-functional requirements, or a new section if needed)
  77. **Why this matters**: Brainstorming documents are often long, and the PRD's structured template has an implicit bias toward concrete/structural ideas. Soft ideas (tone, philosophy, interaction feel) frequently get silently dropped because they don't map cleanly to FR/NFR format.
  78. ### 3. Optimization Actions
  79. Make targeted improvements:
  80. **Improve Flow:**
  81. - Add transition sentences between sections
  82. - Smooth out jarring topic shifts
  83. - Ensure logical progression
  84. - Connect related concepts across sections
  85. **Reduce Duplication:**
  86. - Consolidate repeated information
  87. - Keep content in the most appropriate section
  88. - Use cross-references instead of repetition
  89. - Remove redundant explanations
  90. **Enhance Coherence:**
  91. - Ensure consistent terminology throughout
  92. - Align all sections with product differentiator
  93. - Maintain consistent voice and tone
  94. - Verify scope consistency across sections
  95. **Optimize Headers:**
  96. - Ensure all main sections use ## Level 2
  97. - Make headers descriptive and action-oriented
  98. - Check that headers follow consistent patterns
  99. - Verify headers support document navigation
  100. ### 4. Preserve Critical Information
  101. **While optimizing, ensure NOTHING essential is lost:**
  102. **Must Preserve:**
  103. - All user success criteria
  104. - All functional requirements (capability contract)
  105. - All user journey narratives
  106. - All scope decisions (whether phased or single-release), including consent-critical evidence (explicit user confirmations and rationales for any scope changes from step 8)
  107. - All non-functional requirements
  108. - Product differentiator and vision
  109. - Domain-specific requirements
  110. - Innovation analysis (if present)
  111. **Can Consolidate:**
  112. - Repeated explanations of the same concept
  113. - Redundant background information
  114. - Multiple versions of similar content
  115. - Overlapping examples
  116. ### 5. Generate Optimized Document
  117. Create the polished version:
  118. **Polishing Process:**
  119. 1. Start with original document
  120. 2. Apply all optimization actions
  121. 3. Review to ensure nothing essential was lost
  122. 4. Verify improvements enhance readability
  123. 5. Prepare optimized version for review
  124. ### 6. Present MENU OPTIONS
  125. Present the polished document for review, then display menu:
  126. - Show what changed in the polish
  127. - Highlight improvements made (flow, duplication, headers)
  128. - Ask if they'd like to refine further, get other perspectives, or proceed
  129. - Present menu options naturally as part of conversation
  130. Display: "**Select:** [A] Advanced Elicitation [P] Party Mode [C] Continue to Complete PRD (Step 12 of 12)"
  131. #### Menu Handling Logic:
  132. - IF A: Invoke the `bmad-advanced-elicitation` skill with the polished document, process the enhanced refinements that come back, ask user "Accept these polish improvements? (y/n)", if yes update content with improvements then redisplay menu, if no keep original polish then redisplay menu
  133. - IF P: Invoke the `bmad-party-mode` skill with the polished document, process the collaborative refinements to flow and coherence, ask user "Accept these polish changes? (y/n)", if yes update content with improvements then redisplay menu, if no keep original polish then redisplay menu
  134. - IF C: Save the polished document to {outputFile}, update frontmatter by adding this step name to the end of the stepsCompleted array, then read fully and follow: ./step-12-complete.md
  135. - IF Any other: help user respond, then redisplay menu
  136. #### EXECUTION RULES:
  137. - ALWAYS halt and wait for user input after presenting menu
  138. - ONLY proceed to next step when user selects 'C'
  139. - After other menu items execution, return to this menu
  140. ## APPEND TO DOCUMENT:
  141. When user selects 'C', replace the entire document content with the polished version.
  142. ## SUCCESS METRICS:
  143. ✅ Complete document loaded and reviewed
  144. ✅ Flow and coherence improved
  145. ✅ Duplication reduced while preserving essential information
  146. ✅ All main sections use ## Level 2 headers
  147. ✅ Transitions between sections are smooth
  148. ✅ User's voice and intent preserved
  149. ✅ Document is more readable and professional
  150. ✅ A/P/C menu presented and handled correctly
  151. ✅ Brainstorming reconciliation completed (if brainstorming input exists)
  152. ✅ Polished document saved when C selected
  153. ## FAILURE MODES:
  154. ❌ Loading only partial document (leads to incomplete polish)
  155. ❌ Removing essential information while reducing duplication
  156. ❌ Not preserving user's voice and intent
  157. ❌ Changing content instead of improving presentation
  158. ❌ Not ensuring ## Level 2 headers for main sections
  159. ❌ Making arbitrary style changes instead of coherence improvements
  160. ❌ Not presenting A/P/C menu for user approval
  161. ❌ Saving polished document without user selecting 'C'
  162. ❌ **CRITICAL**: Reading only partial step file - leads to incomplete understanding and poor decisions
  163. ❌ **CRITICAL**: Proceeding with 'C' without fully reading and understanding the next step file
  164. ❌ **CRITICAL**: Making changes without complete understanding of document requirements
  165. ## NEXT STEP:
  166. After user selects 'C' and polished document is saved, load `./step-12-complete.md` to complete the workflow.
  167. Remember: Do NOT proceed to step-12 until user explicitly selects 'C' from the A/P/C menu and polished document is saved!