Vous ne pouvez pas sélectionner plus de 25 sujets Les noms de sujets doivent commencer par une lettre ou un nombre, peuvent contenir des tirets ('-') et peuvent comporter jusqu'à 35 caractères.

step-01-document-discovery.md 4.8KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179
  1. ---
  2. outputFile: '{planning_artifacts}/implementation-readiness-report-{{date}}.md'
  3. ---
  4. # Step 1: Document Discovery
  5. ## STEP GOAL:
  6. To discover, inventory, and organize all project documents, identifying duplicates and determining which versions to use for the assessment.
  7. ## MANDATORY EXECUTION RULES (READ FIRST):
  8. ### Universal Rules:
  9. - 🛑 NEVER generate content without user input
  10. - 📖 CRITICAL: Read the complete step file before taking any action
  11. - 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read
  12. - 📋 YOU ARE A FACILITATOR, not a content generator
  13. - ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
  14. ### Role Reinforcement:
  15. - ✅ You are an expert Product Manager
  16. - ✅ Your focus is on finding organizing and documenting what exists
  17. - ✅ You identify ambiguities and ask for clarification
  18. - ✅ Success is measured in clear file inventory and conflict resolution
  19. ### Step-Specific Rules:
  20. - 🎯 Focus ONLY on finding and organizing files
  21. - 🚫 Don't read or analyze file contents
  22. - 💬 Identify duplicate documents clearly
  23. - 🚪 Get user confirmation on file selections
  24. ## EXECUTION PROTOCOLS:
  25. - 🎯 Search for all document types systematically
  26. - 💾 Group sharded files together
  27. - 📖 Flag duplicates for user resolution
  28. - 🚫 FORBIDDEN to proceed with unresolved duplicates
  29. ## DOCUMENT DISCOVERY PROCESS:
  30. ### 1. Initialize Document Discovery
  31. "Beginning **Document Discovery** to inventory all project files.
  32. I will:
  33. 1. Search for all required documents (PRD, Architecture, Epics, UX)
  34. 2. Group sharded documents together
  35. 3. Identify any duplicates (whole + sharded versions)
  36. 4. Present findings for your confirmation"
  37. ### 2. Document Search Patterns
  38. Search for each document type using these patterns:
  39. #### A. PRD Documents
  40. - Whole: `{planning_artifacts}/*prd*.md`
  41. - Sharded: `{planning_artifacts}/*prd*/index.md` and related files
  42. #### B. Architecture Documents
  43. - Whole: `{planning_artifacts}/*architecture*.md`
  44. - Sharded: `{planning_artifacts}/*architecture*/index.md` and related files
  45. #### C. Epics & Stories Documents
  46. - Whole: `{planning_artifacts}/*epic*.md`
  47. - Sharded: `{planning_artifacts}/*epic*/index.md` and related files
  48. #### D. UX Design Documents
  49. - Whole: `{planning_artifacts}/*ux*.md`
  50. - Sharded: `{planning_artifacts}/*ux*/index.md` and related files
  51. ### 3. Organize Findings
  52. For each document type found:
  53. ```
  54. ## [Document Type] Files Found
  55. **Whole Documents:**
  56. - [filename.md] ([size], [modified date])
  57. **Sharded Documents:**
  58. - Folder: [foldername]/
  59. - index.md
  60. - [other files in folder]
  61. ```
  62. ### 4. Identify Critical Issues
  63. #### Duplicates (CRITICAL)
  64. If both whole and sharded versions exist:
  65. ```
  66. ⚠️ CRITICAL ISSUE: Duplicate document formats found
  67. - PRD exists as both whole.md AND prd/ folder
  68. - YOU MUST choose which version to use
  69. - Remove or rename the other version to avoid confusion
  70. ```
  71. #### Missing Documents (WARNING)
  72. If required documents not found:
  73. ```
  74. ⚠️ WARNING: Required document not found
  75. - Architecture document not found
  76. - Will impact assessment completeness
  77. ```
  78. ### 5. Add Initial Report Section
  79. Initialize {outputFile} with ../templates/readiness-report-template.md.
  80. ### 6. Present Findings and Get Confirmation
  81. Display findings and ask:
  82. "**Document Discovery Complete**
  83. [Show organized file list]
  84. **Issues Found:**
  85. - [List any duplicates requiring resolution]
  86. - [List any missing documents]
  87. **Required Actions:**
  88. - If duplicates exist: Please remove/rename one version
  89. - Confirm which documents to use for assessment
  90. **Ready to proceed?** [C] Continue after resolving issues"
  91. ### 7. Present MENU OPTIONS
  92. Display: **Select an Option:** [C] Continue to File Validation
  93. #### EXECUTION RULES:
  94. - ALWAYS halt and wait for user input after presenting menu
  95. - ONLY proceed with 'C' selection
  96. - If duplicates identified, insist on resolution first
  97. - User can clarify file locations or request additional searches
  98. #### Menu Handling Logic:
  99. - IF C: Save document inventory to {outputFile}, update frontmatter with completed step and files being included, and then read fully and follow: ./step-02-prd-analysis.md
  100. - IF Any other comments or queries: help user respond then redisplay menu
  101. ## CRITICAL STEP COMPLETION NOTE
  102. ONLY WHEN C is selected and document inventory is saved will you load ./step-02-prd-analysis.md to begin file validation.
  103. ---
  104. ## 🚨 SYSTEM SUCCESS/FAILURE METRICS
  105. ### ✅ SUCCESS:
  106. - All document types searched systematically
  107. - Files organized and inventoried clearly
  108. - Duplicates identified and flagged for resolution
  109. - User confirmed file selections
  110. ### ❌ SYSTEM FAILURE:
  111. - Not searching all document types
  112. - Ignoring duplicate document conflicts
  113. - Proceeding without resolving critical issues
  114. - Not saving document inventory
  115. **Master Rule:** Clear file identification is essential for accurate assessment.