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.

checklist.md 5.5KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198
  1. # Teach Me Testing - Quality Checklist
  2. ## Workflow Quality Standards
  3. Use this checklist to validate the teaching workflow meets quality standards.
  4. ---
  5. ## Foundation Quality
  6. - [ ] **SKILL.md** exists with proper frontmatter
  7. - [ ] **customize.toml** defines activation hooks and persistent facts
  8. - [ ] Tri-modal routing logic present (Create/Edit/Validate)
  9. - [ ] Configuration loading references correct module (TEA)
  10. - [ ] First step path correct (`{skill-root}/steps-c/step-01-init.md`)
  11. - [ ] Folder structure complete (steps-c/, steps-e/, steps-v/, data/, templates/)
  12. ---
  13. ## Template Quality
  14. - [ ] **progress-template.yaml** has complete schema
  15. - [ ] All 7 sessions defined with proper structure
  16. - [ ] Session status tracking fields present (not-started/in-progress/completed)
  17. - [ ] stepsCompleted array for continuation tracking
  18. - [ ] **session-notes-template.md** has all required sections
  19. - [ ] **certificate-template.md** includes all 7 sessions
  20. ---
  21. ## Step File Quality (CREATE mode)
  22. ### Initialization Steps
  23. - [ ] **step-01-init.md** checks for existing progress file
  24. - [ ] Continuation detection logic works correctly
  25. - [ ] **step-01b-continue.md** loads progress and routes to session menu
  26. - [ ] Progress dashboard displays completion status
  27. ### Assessment Step
  28. - [ ] **step-02-assess.md** gathers role, experience, goals
  29. - [ ] Validation for role (QA/Dev/Lead/VP)
  30. - [ ] Validation for experience (beginner/intermediate/experienced)
  31. - [ ] Assessment data written to progress file
  32. ### Session Menu Hub
  33. - [ ] **step-03-session-menu.md** displays all 7 sessions
  34. - [ ] Completion indicators shown (✓ completed, 🔄 in-progress, ⬜ not-started)
  35. - [ ] Branching logic routes to selected session (1-7)
  36. - [ ] Exit logic (X) routes to completion if all done, otherwise saves and exits
  37. ### Session Steps (1-7)
  38. - [ ] Each session loads relevant TEA docs just-in-time
  39. - [ ] Teaching content presented (mostly autonomous)
  40. - [ ] Quiz validation with ≥70% threshold
  41. - [ ] Session notes artifact generated
  42. - [ ] Progress file updated (status, score, artifact path)
  43. - [ ] Returns to session menu hub after completion
  44. ### Completion Step
  45. - [ ] **step-05-completion.md** verifies all 7 sessions complete
  46. - [ ] Certificate generated with accurate data
  47. - [ ] Final progress file update (certificate_generated: true)
  48. - [ ] Congratulations message shown
  49. ---
  50. ## Data File Quality
  51. - [ ] **curriculum.yaml** defines all 7 sessions
  52. - [ ] **role-paths.yaml** maps role customizations
  53. - [ ] **session-content-map.yaml** references TEA docs/fragments/URLs correctly
  54. - [ ] **quiz-questions.yaml** has questions for all sessions
  55. - [ ] **tea-resources-index.yaml** has complete documentation index
  56. ---
  57. ## Content Quality
  58. ### TEA Documentation Integration
  59. - [ ] Local file paths correct (`/docs/*.md`, `/src/agents/bmad-tea/resources/knowledge/*.md`)
  60. - [ ] Online URLs correct (<https://bmad-code-org.github.io/...>)
  61. - [ ] GitHub fragment links correct
  62. - [ ] Triple reference system (local + online + GitHub) implemented
  63. ### Role-Based Content
  64. - [ ] QA examples present (practical testing focus)
  65. - [ ] Dev examples present (integration/TDD focus)
  66. - [ ] Lead examples present (architecture/patterns focus)
  67. - [ ] VP examples present (strategy/metrics focus)
  68. ### Quiz Quality
  69. - [ ] Questions test understanding, not memorization
  70. - [ ] 3-5 questions per session
  71. - [ ] Mix of difficulty levels
  72. - [ ] Clear correct answers with explanations
  73. ---
  74. ## Error Handling
  75. - [ ] Corrupted progress file detection
  76. - [ ] Backup and recovery options
  77. - [ ] Missing TEA docs fallback (Web-Browsing)
  78. - [ ] Quiz failure recovery (review or continue)
  79. - [ ] Session interruption handling (auto-save)
  80. ---
  81. ## User Experience
  82. - [ ] Clear navigation instructions
  83. - [ ] Progress visibility (completion percentage, next recommended)
  84. - [ ] Auto-save after each session
  85. - [ ] Resume capability works seamlessly
  86. - [ ] Exit options clear at all decision points
  87. ---
  88. ## State Management
  89. - [ ] stepsCompleted array updated correctly
  90. - [ ] Session tracking accurate (status, dates, scores)
  91. - [ ] Completion percentage calculated correctly
  92. - [ ] Next recommended session logic works
  93. - [ ] lastStep and lastContinued timestamps updated
  94. ---
  95. ## Validation Mode
  96. - [ ] **step-v-01-validate.md** checks all quality standards
  97. - [ ] Generates validation report
  98. - [ ] Identifies issues clearly
  99. - [ ] Provides remediation suggestions
  100. ---
  101. ## Edit Mode
  102. - [ ] **step-e-01-assess-workflow.md** identifies what to edit
  103. - [ ] **step-e-02-apply-edits.md** applies modifications safely
  104. - [ ] Preserves workflow integrity during edits
  105. ---
  106. ## Documentation
  107. - [ ] **instructions.md** clear and complete
  108. - [ ] **checklist.md** (this file) comprehensive
  109. - [ ] README (if present) accurate
  110. - [ ] Inline comments in complex logic
  111. ---
  112. ## Performance
  113. - [ ] Just-in-time loading (not loading all docs upfront)
  114. - [ ] Session steps complete in reasonable time (<5 min)
  115. - [ ] Quiz validation fast (<1 min)
  116. - [ ] Progress file writes efficient
  117. ---
  118. ## Security
  119. - [ ] No hardcoded credentials
  120. - [ ] File paths use variables
  121. - [ ] Progress files private to user
  122. - [ ] No sensitive data in session notes
  123. ---
  124. ## Completion Criteria
  125. ✅ **Workflow is ready for deployment when:**
  126. - All checkboxes above are checked
  127. - All step files exist and follow standards
  128. - All templates present and correct
  129. - Data files complete and accurate
  130. - Error handling robust
  131. - User experience smooth
  132. - Documentation complete
  133. ---
  134. **Validation Date:** **\*\***\_\_\_**\*\***
  135. **Validated By:** **\*\***\_\_\_**\*\***
  136. **Issues Found:** **\*\***\_\_\_**\*\***
  137. **Status:** ⬜ Ready for Production | ⬜ Needs Revisions