@mytechtoday/augment-extensions 0.7.0 → 1.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (483) hide show
  1. package/AGENTS.md +265 -232
  2. package/README.md +956 -771
  3. package/augment-extensions/coding-standards/bash/README.md +196 -196
  4. package/augment-extensions/coding-standards/bash/module.json +163 -163
  5. package/augment-extensions/coding-standards/bash/rules/naming-conventions.md +336 -336
  6. package/augment-extensions/coding-standards/bash/rules/universal-standards.md +289 -289
  7. package/augment-extensions/coding-standards/css/README.md +40 -40
  8. package/augment-extensions/coding-standards/css/examples/css-examples.css +550 -550
  9. package/augment-extensions/coding-standards/css/module.json +44 -44
  10. package/augment-extensions/coding-standards/css/rules/css-modern-features.md +448 -448
  11. package/augment-extensions/coding-standards/css/rules/css-standards.md +492 -492
  12. package/augment-extensions/coding-standards/html/README.md +40 -40
  13. package/augment-extensions/coding-standards/html/examples/html-examples.html +267 -267
  14. package/augment-extensions/coding-standards/html/examples/responsive-layout.html +505 -505
  15. package/augment-extensions/coding-standards/html/module.json +44 -44
  16. package/augment-extensions/coding-standards/html/rules/html-standards.md +349 -349
  17. package/augment-extensions/coding-standards/html-css-js/README.md +194 -194
  18. package/augment-extensions/coding-standards/html-css-js/examples/async-examples.js +487 -487
  19. package/augment-extensions/coding-standards/html-css-js/examples/css-examples.css +550 -550
  20. package/augment-extensions/coding-standards/html-css-js/examples/dom-examples.js +667 -667
  21. package/augment-extensions/coding-standards/html-css-js/examples/html-examples.html +267 -267
  22. package/augment-extensions/coding-standards/html-css-js/examples/javascript-examples.js +612 -612
  23. package/augment-extensions/coding-standards/html-css-js/examples/responsive-layout.html +505 -505
  24. package/augment-extensions/coding-standards/html-css-js/module.json +48 -48
  25. package/augment-extensions/coding-standards/html-css-js/rules/async-patterns.md +515 -515
  26. package/augment-extensions/coding-standards/html-css-js/rules/css-modern-features.md +448 -448
  27. package/augment-extensions/coding-standards/html-css-js/rules/css-standards.md +492 -492
  28. package/augment-extensions/coding-standards/html-css-js/rules/dom-manipulation.md +439 -439
  29. package/augment-extensions/coding-standards/html-css-js/rules/html-standards.md +349 -349
  30. package/augment-extensions/coding-standards/html-css-js/rules/javascript-standards.md +486 -486
  31. package/augment-extensions/coding-standards/html-css-js/rules/performance.md +463 -463
  32. package/augment-extensions/coding-standards/html-css-js/rules/tooling.md +543 -543
  33. package/augment-extensions/coding-standards/js/README.md +46 -46
  34. package/augment-extensions/coding-standards/js/examples/async-examples.js +487 -487
  35. package/augment-extensions/coding-standards/js/examples/dom-examples.js +667 -667
  36. package/augment-extensions/coding-standards/js/examples/javascript-examples.js +612 -612
  37. package/augment-extensions/coding-standards/js/module.json +49 -49
  38. package/augment-extensions/coding-standards/js/rules/async-patterns.md +515 -515
  39. package/augment-extensions/coding-standards/js/rules/dom-manipulation.md +439 -439
  40. package/augment-extensions/coding-standards/js/rules/javascript-standards.md +486 -486
  41. package/augment-extensions/coding-standards/js/rules/performance.md +463 -463
  42. package/augment-extensions/coding-standards/js/rules/tooling.md +543 -543
  43. package/augment-extensions/coding-standards/php/README.md +248 -248
  44. package/augment-extensions/coding-standards/php/examples/api-endpoint-example.php +204 -204
  45. package/augment-extensions/coding-standards/php/examples/cli-command-example.php +206 -206
  46. package/augment-extensions/coding-standards/php/examples/legacy-refactoring-example.php +234 -234
  47. package/augment-extensions/coding-standards/php/examples/web-application-example.php +211 -211
  48. package/augment-extensions/coding-standards/php/examples/woocommerce-extension-example.php +215 -215
  49. package/augment-extensions/coding-standards/php/examples/wordpress-plugin-example.php +189 -189
  50. package/augment-extensions/coding-standards/php/module.json +166 -166
  51. package/augment-extensions/coding-standards/php/rules/api-development.md +480 -480
  52. package/augment-extensions/coding-standards/php/rules/category-configuration.md +332 -332
  53. package/augment-extensions/coding-standards/php/rules/cli-tools.md +472 -472
  54. package/augment-extensions/coding-standards/php/rules/cms-integration.md +561 -561
  55. package/augment-extensions/coding-standards/php/rules/code-quality.md +402 -402
  56. package/augment-extensions/coding-standards/php/rules/documentation.md +425 -425
  57. package/augment-extensions/coding-standards/php/rules/ecommerce.md +627 -627
  58. package/augment-extensions/coding-standards/php/rules/error-handling.md +336 -336
  59. package/augment-extensions/coding-standards/php/rules/legacy-migration.md +677 -677
  60. package/augment-extensions/coding-standards/php/rules/naming-conventions.md +279 -279
  61. package/augment-extensions/coding-standards/php/rules/performance.md +392 -392
  62. package/augment-extensions/coding-standards/php/rules/psr-standards.md +186 -186
  63. package/augment-extensions/coding-standards/php/rules/security.md +358 -358
  64. package/augment-extensions/coding-standards/php/rules/testing.md +403 -403
  65. package/augment-extensions/coding-standards/php/rules/type-declarations.md +331 -331
  66. package/augment-extensions/coding-standards/php/rules/web-applications.md +426 -426
  67. package/augment-extensions/coding-standards/powershell/README.md +154 -154
  68. package/augment-extensions/coding-standards/powershell/examples/admin-example.ps1 +272 -272
  69. package/augment-extensions/coding-standards/powershell/examples/automation-example.ps1 +173 -173
  70. package/augment-extensions/coding-standards/powershell/examples/cloud-example.ps1 +243 -243
  71. package/augment-extensions/coding-standards/powershell/examples/cross-platform-example.ps1 +297 -297
  72. package/augment-extensions/coding-standards/powershell/examples/dsc-example.ps1 +224 -224
  73. package/augment-extensions/coding-standards/powershell/examples/legacy-migration-example.ps1 +340 -340
  74. package/augment-extensions/coding-standards/powershell/examples/module-example.psm1 +255 -255
  75. package/augment-extensions/coding-standards/powershell/module.json +165 -165
  76. package/augment-extensions/coding-standards/powershell/rules/administrative-tools.md +439 -439
  77. package/augment-extensions/coding-standards/powershell/rules/automation-scripts.md +240 -240
  78. package/augment-extensions/coding-standards/powershell/rules/cloud-orchestration.md +384 -384
  79. package/augment-extensions/coding-standards/powershell/rules/configuration-schema.md +383 -383
  80. package/augment-extensions/coding-standards/powershell/rules/cross-platform-scripts.md +482 -482
  81. package/augment-extensions/coding-standards/powershell/rules/dsc-configurations.md +296 -296
  82. package/augment-extensions/coding-standards/powershell/rules/error-handling.md +314 -314
  83. package/augment-extensions/coding-standards/powershell/rules/legacy-migrations.md +466 -466
  84. package/augment-extensions/coding-standards/powershell/rules/modules-functions.md +244 -244
  85. package/augment-extensions/coding-standards/powershell/rules/naming-conventions.md +266 -266
  86. package/augment-extensions/coding-standards/powershell/rules/performance-optimization.md +209 -209
  87. package/augment-extensions/coding-standards/powershell/rules/security-practices.md +314 -314
  88. package/augment-extensions/coding-standards/powershell/rules/testing-guidelines.md +268 -268
  89. package/augment-extensions/coding-standards/powershell/rules/universal-standards.md +197 -197
  90. package/augment-extensions/coding-standards/python/README.md +48 -48
  91. package/augment-extensions/coding-standards/python/examples/best-practices.py +373 -373
  92. package/augment-extensions/coding-standards/python/module.json +30 -30
  93. package/augment-extensions/coding-standards/python/rules/async-patterns.md +884 -884
  94. package/augment-extensions/coding-standards/python/rules/best-practices.md +232 -232
  95. package/augment-extensions/coding-standards/python/rules/code-organization.md +220 -220
  96. package/augment-extensions/coding-standards/python/rules/documentation.md +831 -831
  97. package/augment-extensions/coding-standards/python/rules/error-handling.md +1008 -1008
  98. package/augment-extensions/coding-standards/python/rules/naming-conventions.md +172 -172
  99. package/augment-extensions/coding-standards/python/rules/testing.md +409 -409
  100. package/augment-extensions/coding-standards/python/rules/tooling.md +446 -446
  101. package/augment-extensions/coding-standards/python/rules/type-hints.md +253 -253
  102. package/augment-extensions/coding-standards/react/README.md +45 -45
  103. package/augment-extensions/coding-standards/react/module.json +27 -27
  104. package/augment-extensions/coding-standards/react/rules/component-patterns.md +214 -214
  105. package/augment-extensions/coding-standards/react/rules/hooks-best-practices.md +235 -235
  106. package/augment-extensions/coding-standards/react/rules/performance.md +300 -300
  107. package/augment-extensions/coding-standards/react/rules/state-management.md +265 -265
  108. package/augment-extensions/coding-standards/react/rules/typescript-react.md +271 -271
  109. package/augment-extensions/coding-standards/typescript/README.md +45 -45
  110. package/augment-extensions/coding-standards/typescript/module.json +27 -27
  111. package/augment-extensions/coding-standards/typescript/rules/naming-conventions.md +225 -225
  112. package/augment-extensions/collections/html-css-js/README.md +82 -82
  113. package/augment-extensions/collections/html-css-js/collection.json +41 -41
  114. package/augment-extensions/domain-rules/api-design/README.md +41 -41
  115. package/augment-extensions/domain-rules/api-design/module.json +27 -27
  116. package/augment-extensions/domain-rules/api-design/rules/authentication.md +263 -263
  117. package/augment-extensions/domain-rules/api-design/rules/documentation.md +395 -395
  118. package/augment-extensions/domain-rules/api-design/rules/error-handling.md +290 -290
  119. package/augment-extensions/domain-rules/api-design/rules/graphql-api.md +313 -313
  120. package/augment-extensions/domain-rules/api-design/rules/rest-api.md +214 -214
  121. package/augment-extensions/domain-rules/api-design/rules/versioning.md +268 -268
  122. package/augment-extensions/domain-rules/database/README.md +161 -161
  123. package/augment-extensions/domain-rules/database/examples/flat-database-example.md +793 -793
  124. package/augment-extensions/domain-rules/database/examples/hybrid-database-example.md +1132 -1132
  125. package/augment-extensions/domain-rules/database/examples/nosql-document-example.md +868 -868
  126. package/augment-extensions/domain-rules/database/examples/nosql-graph-example.md +805 -805
  127. package/augment-extensions/domain-rules/database/examples/relational-schema-example.md +621 -621
  128. package/augment-extensions/domain-rules/database/examples/vector-database-example.md +965 -965
  129. package/augment-extensions/domain-rules/database/module.json +28 -28
  130. package/augment-extensions/domain-rules/database/rules/flat-databases.md +624 -624
  131. package/augment-extensions/domain-rules/database/rules/nosql-databases.md +588 -588
  132. package/augment-extensions/domain-rules/database/rules/nosql-document-stores.md +856 -856
  133. package/augment-extensions/domain-rules/database/rules/nosql-graph-databases.md +778 -778
  134. package/augment-extensions/domain-rules/database/rules/nosql-key-value-stores.md +963 -963
  135. package/augment-extensions/domain-rules/database/rules/performance-optimization.md +1076 -1076
  136. package/augment-extensions/domain-rules/database/rules/relational-databases.md +697 -697
  137. package/augment-extensions/domain-rules/database/rules/relational-indexing.md +671 -671
  138. package/augment-extensions/domain-rules/database/rules/relational-query-optimization.md +607 -607
  139. package/augment-extensions/domain-rules/database/rules/relational-schema-design.md +907 -907
  140. package/augment-extensions/domain-rules/database/rules/relational-transactions.md +783 -783
  141. package/augment-extensions/domain-rules/database/rules/security-standards.md +980 -980
  142. package/augment-extensions/domain-rules/database/rules/universal-best-practices.md +485 -485
  143. package/augment-extensions/domain-rules/database/rules/vector-databases.md +521 -521
  144. package/augment-extensions/domain-rules/database/rules/vector-embeddings.md +858 -858
  145. package/augment-extensions/domain-rules/database/rules/vector-indexing.md +934 -934
  146. package/augment-extensions/domain-rules/design/color/themes/catppuccin-latte/README.md +23 -23
  147. package/augment-extensions/domain-rules/design/color/themes/catppuccin-latte/module.json +26 -26
  148. package/augment-extensions/domain-rules/design/color/themes/catppuccin-mocha/README.md +23 -23
  149. package/augment-extensions/domain-rules/design/color/themes/catppuccin-mocha/module.json +26 -26
  150. package/augment-extensions/domain-rules/design/color/themes/dracula/README.md +23 -23
  151. package/augment-extensions/domain-rules/design/color/themes/dracula/module.json +26 -26
  152. package/augment-extensions/domain-rules/design/color/themes/gruvbox-dark/README.md +23 -23
  153. package/augment-extensions/domain-rules/design/color/themes/gruvbox-dark/module.json +26 -26
  154. package/augment-extensions/domain-rules/design/color/themes/gruvbox-light/README.md +23 -23
  155. package/augment-extensions/domain-rules/design/color/themes/gruvbox-light/module.json +26 -26
  156. package/augment-extensions/domain-rules/design/color/themes/high-contrast/README.md +27 -27
  157. package/augment-extensions/domain-rules/design/color/themes/high-contrast/module.json +26 -26
  158. package/augment-extensions/domain-rules/design/color/themes/monokai/README.md +23 -23
  159. package/augment-extensions/domain-rules/design/color/themes/monokai/module.json +26 -26
  160. package/augment-extensions/domain-rules/design/color/themes/nord/README.md +23 -23
  161. package/augment-extensions/domain-rules/design/color/themes/nord/module.json +26 -26
  162. package/augment-extensions/domain-rules/design/color/themes/one-dark/README.md +23 -23
  163. package/augment-extensions/domain-rules/design/color/themes/one-dark/module.json +26 -26
  164. package/augment-extensions/domain-rules/design/color/themes/one-light/README.md +23 -23
  165. package/augment-extensions/domain-rules/design/color/themes/one-light/module.json +26 -26
  166. package/augment-extensions/domain-rules/design/color/themes/solarized-dark/README.md +23 -23
  167. package/augment-extensions/domain-rules/design/color/themes/solarized-dark/module.json +26 -26
  168. package/augment-extensions/domain-rules/design/color/themes/solarized-light/README.md +23 -23
  169. package/augment-extensions/domain-rules/design/color/themes/solarized-light/module.json +26 -26
  170. package/augment-extensions/domain-rules/design/color/themes/tokyo-night/README.md +23 -23
  171. package/augment-extensions/domain-rules/design/color/themes/tokyo-night/module.json +26 -26
  172. package/augment-extensions/domain-rules/mcp/README.md +150 -150
  173. package/augment-extensions/domain-rules/mcp/examples/compressed-example.md +522 -522
  174. package/augment-extensions/domain-rules/mcp/examples/graph-augmented-example.md +520 -520
  175. package/augment-extensions/domain-rules/mcp/examples/hybrid-example.md +570 -570
  176. package/augment-extensions/domain-rules/mcp/examples/state-based-example.md +427 -427
  177. package/augment-extensions/domain-rules/mcp/examples/token-based-example.md +435 -435
  178. package/augment-extensions/domain-rules/mcp/examples/vector-based-example.md +502 -502
  179. package/augment-extensions/domain-rules/mcp/module.json +49 -49
  180. package/augment-extensions/domain-rules/mcp/rules/compressed-mcp.md +595 -595
  181. package/augment-extensions/domain-rules/mcp/rules/configuration.md +345 -345
  182. package/augment-extensions/domain-rules/mcp/rules/graph-augmented-mcp.md +687 -687
  183. package/augment-extensions/domain-rules/mcp/rules/hybrid-mcp.md +636 -636
  184. package/augment-extensions/domain-rules/mcp/rules/state-based-mcp.md +484 -484
  185. package/augment-extensions/domain-rules/mcp/rules/testing-validation.md +360 -360
  186. package/augment-extensions/domain-rules/mcp/rules/token-based-mcp.md +393 -393
  187. package/augment-extensions/domain-rules/mcp/rules/universal-rules.md +194 -194
  188. package/augment-extensions/domain-rules/mcp/rules/vector-based-mcp.md +625 -625
  189. package/augment-extensions/domain-rules/security/README.md +41 -41
  190. package/augment-extensions/domain-rules/security/module.json +28 -28
  191. package/augment-extensions/domain-rules/security/rules/authentication-security.md +361 -361
  192. package/augment-extensions/domain-rules/security/rules/encryption.md +208 -208
  193. package/augment-extensions/domain-rules/security/rules/input-validation.md +294 -294
  194. package/augment-extensions/domain-rules/security/rules/owasp-top-10.md +339 -339
  195. package/augment-extensions/domain-rules/security/rules/secure-coding.md +293 -293
  196. package/augment-extensions/domain-rules/security/rules/web-security.md +268 -268
  197. package/augment-extensions/domain-rules/seo-sales-marketing/ANNOUNCEMENT.md +143 -0
  198. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/README.md +140 -136
  199. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/SCHEMA-VALIDATION-REPORT.md +216 -216
  200. package/augment-extensions/domain-rules/seo-sales-marketing/TEST-VALIDATION.md +129 -0
  201. package/augment-extensions/domain-rules/seo-sales-marketing/USAGE-GUIDES.md +254 -0
  202. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/examples/brand-kit-example.yaml +292 -292
  203. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/examples/campaign-brief-example.yaml +389 -389
  204. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/examples/content-calendar-example.yaml +643 -643
  205. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/examples/email-newsletter-example.md +376 -376
  206. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/examples/landing-page-example.md +934 -934
  207. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/examples/ppc-ad-copy-example.md +301 -301
  208. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/examples/seo-blog-post-example.md +347 -347
  209. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/examples/social-media-campaign-example.md +606 -606
  210. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/module.json +50 -50
  211. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/affiliate-influencer-marketing.md +593 -593
  212. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/asset-management.md +418 -418
  213. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/brand-consistency.md +210 -210
  214. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/content-marketing.md +337 -337
  215. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/conversion-optimization.md +455 -455
  216. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/direct-sales.md +499 -499
  217. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/email-marketing.md +439 -439
  218. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/legal-compliance.md +227 -227
  219. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/ppc-advertising.md +569 -569
  220. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/seo-optimization.md +470 -470
  221. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/social-media-marketing.md +414 -414
  222. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/universal-marketing.md +177 -177
  223. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/schemas/asset-inventory.schema.json +247 -247
  224. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/schemas/brand-kit.schema.json +326 -326
  225. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/schemas/campaign-brief.schema.json +342 -342
  226. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/schemas/color-palette.schema.json +223 -223
  227. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/schemas/content-template.schema.json +383 -383
  228. package/augment-extensions/domain-rules/wordpress/README.md +163 -163
  229. package/augment-extensions/domain-rules/wordpress/module.json +32 -32
  230. package/augment-extensions/domain-rules/wordpress/rules/coding-standards.md +617 -617
  231. package/augment-extensions/domain-rules/wordpress/rules/directory-structure.md +270 -270
  232. package/augment-extensions/domain-rules/wordpress/rules/file-patterns.md +423 -423
  233. package/augment-extensions/domain-rules/wordpress/rules/gutenberg-blocks.md +493 -493
  234. package/augment-extensions/domain-rules/wordpress/rules/performance.md +568 -568
  235. package/augment-extensions/domain-rules/wordpress/rules/plugin-development.md +510 -510
  236. package/augment-extensions/domain-rules/wordpress/rules/project-detection.md +251 -251
  237. package/augment-extensions/domain-rules/wordpress/rules/rest-api.md +501 -501
  238. package/augment-extensions/domain-rules/wordpress/rules/security.md +564 -564
  239. package/augment-extensions/domain-rules/wordpress/rules/theme-development.md +388 -388
  240. package/augment-extensions/domain-rules/wordpress/rules/woocommerce.md +441 -441
  241. package/augment-extensions/domain-rules/wordpress-plugin/README.md +139 -139
  242. package/augment-extensions/domain-rules/wordpress-plugin/examples/ajax-plugin.md +1599 -1599
  243. package/augment-extensions/domain-rules/wordpress-plugin/examples/custom-post-type-plugin.md +1727 -1727
  244. package/augment-extensions/domain-rules/wordpress-plugin/examples/gutenberg-block-plugin.md +428 -428
  245. package/augment-extensions/domain-rules/wordpress-plugin/examples/gutenberg-block.md +422 -422
  246. package/augment-extensions/domain-rules/wordpress-plugin/examples/mvc-plugin.md +1623 -1623
  247. package/augment-extensions/domain-rules/wordpress-plugin/examples/object-oriented-plugin.md +1343 -1343
  248. package/augment-extensions/domain-rules/wordpress-plugin/examples/rest-endpoint.md +734 -734
  249. package/augment-extensions/domain-rules/wordpress-plugin/examples/settings-page-plugin.md +1350 -1350
  250. package/augment-extensions/domain-rules/wordpress-plugin/examples/simple-procedural-plugin.md +503 -503
  251. package/augment-extensions/domain-rules/wordpress-plugin/examples/singleton-plugin.md +971 -971
  252. package/augment-extensions/domain-rules/wordpress-plugin/module.json +53 -53
  253. package/augment-extensions/domain-rules/wordpress-plugin/rules/activation-hooks.md +770 -770
  254. package/augment-extensions/domain-rules/wordpress-plugin/rules/admin-interface.md +874 -874
  255. package/augment-extensions/domain-rules/wordpress-plugin/rules/ajax-handlers.md +629 -629
  256. package/augment-extensions/domain-rules/wordpress-plugin/rules/asset-management.md +559 -559
  257. package/augment-extensions/domain-rules/wordpress-plugin/rules/context-providers.md +709 -709
  258. package/augment-extensions/domain-rules/wordpress-plugin/rules/cron-jobs.md +736 -736
  259. package/augment-extensions/domain-rules/wordpress-plugin/rules/database-management.md +1057 -1057
  260. package/augment-extensions/domain-rules/wordpress-plugin/rules/documentation-standards.md +463 -463
  261. package/augment-extensions/domain-rules/wordpress-plugin/rules/frontend-functionality.md +478 -478
  262. package/augment-extensions/domain-rules/wordpress-plugin/rules/gutenberg-blocks.md +818 -818
  263. package/augment-extensions/domain-rules/wordpress-plugin/rules/internationalization.md +416 -416
  264. package/augment-extensions/domain-rules/wordpress-plugin/rules/migration.md +667 -667
  265. package/augment-extensions/domain-rules/wordpress-plugin/rules/performance-optimization.md +878 -878
  266. package/augment-extensions/domain-rules/wordpress-plugin/rules/plugin-architecture.md +693 -693
  267. package/augment-extensions/domain-rules/wordpress-plugin/rules/plugin-structure.md +352 -352
  268. package/augment-extensions/domain-rules/wordpress-plugin/rules/rest-api.md +818 -818
  269. package/augment-extensions/domain-rules/wordpress-plugin/rules/scaffolding-workflow.md +624 -624
  270. package/augment-extensions/domain-rules/wordpress-plugin/rules/security-best-practices.md +866 -866
  271. package/augment-extensions/domain-rules/wordpress-plugin/rules/testing-patterns.md +1165 -1165
  272. package/augment-extensions/domain-rules/wordpress-plugin/rules/testing.md +414 -414
  273. package/augment-extensions/domain-rules/wordpress-plugin/rules/vscode-integration.md +751 -751
  274. package/augment-extensions/domain-rules/wordpress-plugin/rules/woocommerce-integration.md +949 -949
  275. package/augment-extensions/domain-rules/wordpress-plugin/rules/wordpress-org-submission.md +458 -458
  276. package/augment-extensions/examples/design-patterns/README.md +37 -37
  277. package/augment-extensions/examples/design-patterns/examples/behavioral-patterns.md +370 -370
  278. package/augment-extensions/examples/design-patterns/examples/creational-patterns.md +250 -250
  279. package/augment-extensions/examples/design-patterns/examples/structural-patterns.md +264 -264
  280. package/augment-extensions/examples/design-patterns/module.json +27 -27
  281. package/augment-extensions/examples/gutenberg-block-plugin/README.md +101 -101
  282. package/augment-extensions/examples/gutenberg-block-plugin/examples/testimonial-block.md +428 -428
  283. package/augment-extensions/examples/gutenberg-block-plugin/module.json +40 -40
  284. package/augment-extensions/examples/rest-api-plugin/README.md +98 -98
  285. package/augment-extensions/examples/rest-api-plugin/examples/task-manager-api.md +1299 -1299
  286. package/augment-extensions/examples/rest-api-plugin/module.json +40 -40
  287. package/augment-extensions/examples/woocommerce-extension/README.md +98 -98
  288. package/augment-extensions/examples/woocommerce-extension/examples/product-customizer.md +763 -763
  289. package/augment-extensions/examples/woocommerce-extension/module.json +40 -40
  290. package/augment-extensions/workflows/beads/README.md +135 -135
  291. package/augment-extensions/workflows/beads/examples/complete-workflow-example.md +278 -278
  292. package/augment-extensions/workflows/beads/module.json +55 -55
  293. package/augment-extensions/workflows/beads/rules/best-practices.md +398 -398
  294. package/augment-extensions/workflows/beads/rules/file-format.md +327 -327
  295. package/augment-extensions/workflows/beads/rules/manual-setup.md +315 -315
  296. package/augment-extensions/workflows/beads/rules/workflow.md +326 -326
  297. package/augment-extensions/workflows/beads-integration/IMPLEMENTATION-STATUS.md +145 -145
  298. package/augment-extensions/workflows/beads-integration/README.md +143 -143
  299. package/augment-extensions/workflows/beads-integration/config/defaults.json +32 -32
  300. package/augment-extensions/workflows/beads-integration/config/schema.json +140 -140
  301. package/augment-extensions/workflows/beads-integration/examples/basic-task-generation.md +293 -293
  302. package/augment-extensions/workflows/beads-integration/module.json +75 -75
  303. package/augment-extensions/workflows/beads-integration/rules/core-rules.md +219 -219
  304. package/augment-extensions/workflows/beads-integration/rules/effectiveness-standards.md +256 -256
  305. package/augment-extensions/workflows/beads-integration/rules/task-generation.md +607 -607
  306. package/augment-extensions/workflows/database/README.md +195 -195
  307. package/augment-extensions/workflows/database/ai-prompt-testing.md +295 -295
  308. package/augment-extensions/workflows/database/examples/migration-example.md +498 -498
  309. package/augment-extensions/workflows/database/examples/optimization-example.md +496 -496
  310. package/augment-extensions/workflows/database/examples/schema-design-example.md +444 -444
  311. package/augment-extensions/workflows/database/module.json +42 -42
  312. package/augment-extensions/workflows/database/rules/data-migration.md +249 -249
  313. package/augment-extensions/workflows/database/rules/documentation-standards.md +339 -339
  314. package/augment-extensions/workflows/database/rules/migration-workflow.md +352 -352
  315. package/augment-extensions/workflows/database/rules/optimization-workflow.md +435 -435
  316. package/augment-extensions/workflows/database/rules/schema-design-workflow.md +535 -535
  317. package/augment-extensions/workflows/database/rules/testing-patterns.md +305 -305
  318. package/augment-extensions/workflows/database/rules/workflow.md +458 -458
  319. package/augment-extensions/workflows/wordpress-plugin/README.md +232 -232
  320. package/augment-extensions/workflows/wordpress-plugin/ai-prompts.md +839 -839
  321. package/augment-extensions/workflows/wordpress-plugin/bead-decomposition-patterns.md +854 -854
  322. package/augment-extensions/workflows/wordpress-plugin/examples/complete-plugin-example.md +540 -540
  323. package/augment-extensions/workflows/wordpress-plugin/examples/custom-post-type-example.md +1083 -1083
  324. package/augment-extensions/workflows/wordpress-plugin/examples/feature-addition-workflow.md +669 -669
  325. package/augment-extensions/workflows/wordpress-plugin/examples/plugin-creation-workflow.md +597 -597
  326. package/augment-extensions/workflows/wordpress-plugin/examples/secure-form-handler-example.md +925 -925
  327. package/augment-extensions/workflows/wordpress-plugin/examples/security-audit-workflow.md +752 -752
  328. package/augment-extensions/workflows/wordpress-plugin/examples/wordpress-org-submission-workflow.md +773 -773
  329. package/augment-extensions/workflows/wordpress-plugin/module.json +49 -49
  330. package/augment-extensions/workflows/wordpress-plugin/rules/best-practices.md +942 -942
  331. package/augment-extensions/workflows/wordpress-plugin/rules/development-workflow.md +702 -702
  332. package/augment-extensions/workflows/wordpress-plugin/rules/submission-workflow.md +728 -728
  333. package/augment-extensions/workflows/wordpress-plugin/rules/testing-workflow.md +775 -775
  334. package/augment-extensions/writing-standards/screenplay/README.md +339 -300
  335. package/augment-extensions/writing-standards/screenplay/_templates/README.md +121 -121
  336. package/augment-extensions/writing-standards/screenplay/_templates/genre-template.md +153 -153
  337. package/augment-extensions/writing-standards/screenplay/_templates/style-template.md +243 -243
  338. package/augment-extensions/writing-standards/screenplay/_templates/theme-template.md +213 -213
  339. package/augment-extensions/writing-standards/screenplay/examples/aaa-hollywood-scene.fountain +164 -164
  340. package/augment-extensions/writing-standards/screenplay/examples/beat-sheet-example.yaml +95 -95
  341. package/augment-extensions/writing-standards/screenplay/examples/character-profile-example.yaml +116 -116
  342. package/augment-extensions/writing-standards/screenplay/examples/commercial-30sec.fountain +151 -151
  343. package/augment-extensions/writing-standards/screenplay/examples/independent-monologue.fountain +67 -67
  344. package/augment-extensions/writing-standards/screenplay/examples/news-segment.fountain +142 -142
  345. package/augment-extensions/writing-standards/screenplay/examples/plot-outline-example.yaml +184 -184
  346. package/augment-extensions/writing-standards/screenplay/examples/tv-episode-teaser.fountain +204 -204
  347. package/augment-extensions/writing-standards/screenplay/genres/README.md +181 -181
  348. package/augment-extensions/writing-standards/screenplay/genres/examples/.gitkeep +2 -2
  349. package/augment-extensions/writing-standards/screenplay/genres/module.json +70 -70
  350. package/augment-extensions/writing-standards/screenplay/genres/rules/.gitkeep +2 -2
  351. package/augment-extensions/writing-standards/screenplay/genres/rules/action.md +399 -399
  352. package/augment-extensions/writing-standards/screenplay/genres/rules/adventure.md +407 -407
  353. package/augment-extensions/writing-standards/screenplay/genres/rules/animation.md +293 -293
  354. package/augment-extensions/writing-standards/screenplay/genres/rules/biographical.md +293 -293
  355. package/augment-extensions/writing-standards/screenplay/genres/rules/comedy.md +401 -401
  356. package/augment-extensions/writing-standards/screenplay/genres/rules/documentary.md +293 -293
  357. package/augment-extensions/writing-standards/screenplay/genres/rules/drama.md +409 -409
  358. package/augment-extensions/writing-standards/screenplay/genres/rules/fantasy.md +293 -293
  359. package/augment-extensions/writing-standards/screenplay/genres/rules/historical.md +293 -293
  360. package/augment-extensions/writing-standards/screenplay/genres/rules/horror.md +268 -268
  361. package/augment-extensions/writing-standards/screenplay/genres/rules/musical.md +294 -294
  362. package/augment-extensions/writing-standards/screenplay/genres/rules/mystery.md +293 -293
  363. package/augment-extensions/writing-standards/screenplay/genres/rules/noir.md +294 -294
  364. package/augment-extensions/writing-standards/screenplay/genres/rules/romance.md +293 -293
  365. package/augment-extensions/writing-standards/screenplay/genres/rules/sci-fi.md +289 -289
  366. package/augment-extensions/writing-standards/screenplay/genres/rules/superhero.md +293 -293
  367. package/augment-extensions/writing-standards/screenplay/genres/rules/thriller.md +294 -294
  368. package/augment-extensions/writing-standards/screenplay/genres/rules/western.md +293 -293
  369. package/augment-extensions/writing-standards/screenplay/module.json +124 -124
  370. package/augment-extensions/writing-standards/screenplay/rules/aaa-hollywood-films.md +339 -339
  371. package/augment-extensions/writing-standards/screenplay/rules/ai-integration-testing.md +329 -329
  372. package/augment-extensions/writing-standards/screenplay/rules/character-development.md +169 -169
  373. package/augment-extensions/writing-standards/screenplay/rules/commercials.md +437 -437
  374. package/augment-extensions/writing-standards/screenplay/rules/dialogue-writing.md +263 -263
  375. package/augment-extensions/writing-standards/screenplay/rules/diversity-inclusion.md +261 -261
  376. package/augment-extensions/writing-standards/screenplay/rules/examples-guide.md +315 -315
  377. package/augment-extensions/writing-standards/screenplay/rules/file-organization.md +213 -0
  378. package/augment-extensions/writing-standards/screenplay/rules/formatting-validation.md +413 -413
  379. package/augment-extensions/writing-standards/screenplay/rules/fountain-format.md +372 -372
  380. package/augment-extensions/writing-standards/screenplay/rules/independent-films.md +374 -374
  381. package/augment-extensions/writing-standards/screenplay/rules/live-tv-productions.md +443 -443
  382. package/augment-extensions/writing-standards/screenplay/rules/narrative-structures.md +207 -207
  383. package/augment-extensions/writing-standards/screenplay/rules/news-broadcasts.md +444 -444
  384. package/augment-extensions/writing-standards/screenplay/rules/pacing-timing.md +331 -331
  385. package/augment-extensions/writing-standards/screenplay/rules/quality-review-checklist.md +334 -334
  386. package/augment-extensions/writing-standards/screenplay/rules/quick-reference.md +299 -299
  387. package/augment-extensions/writing-standards/screenplay/rules/screen-continuity.md +263 -263
  388. package/augment-extensions/writing-standards/screenplay/rules/streaming-content.md +412 -412
  389. package/augment-extensions/writing-standards/screenplay/rules/trope-management.md +370 -370
  390. package/augment-extensions/writing-standards/screenplay/rules/tv-series.md +374 -374
  391. package/augment-extensions/writing-standards/screenplay/rules/universal-formatting.md +339 -339
  392. package/augment-extensions/writing-standards/screenplay/rules/vscode-integration.md +277 -277
  393. package/augment-extensions/writing-standards/screenplay/rules/web-content.md +393 -393
  394. package/augment-extensions/writing-standards/screenplay/schemas/beat-sheet.json +332 -332
  395. package/augment-extensions/writing-standards/screenplay/schemas/character-profile.json +247 -247
  396. package/augment-extensions/writing-standards/screenplay/schemas/feature-selection.json +200 -200
  397. package/augment-extensions/writing-standards/screenplay/schemas/plot-outline.json +233 -233
  398. package/augment-extensions/writing-standards/screenplay/schemas/screenplay-config.json +245 -245
  399. package/augment-extensions/writing-standards/screenplay/schemas/trope-inventory.json +221 -221
  400. package/augment-extensions/writing-standards/screenplay/styles/README.md +159 -159
  401. package/augment-extensions/writing-standards/screenplay/styles/examples/.gitkeep +2 -2
  402. package/augment-extensions/writing-standards/screenplay/styles/examples/style-applications.md +1449 -1449
  403. package/augment-extensions/writing-standards/screenplay/styles/module.json +64 -64
  404. package/augment-extensions/writing-standards/screenplay/styles/rules/.gitkeep +2 -2
  405. package/augment-extensions/writing-standards/screenplay/styles/rules/dialogue-centric.md +520 -520
  406. package/augment-extensions/writing-standards/screenplay/styles/rules/ensemble.md +499 -499
  407. package/augment-extensions/writing-standards/screenplay/styles/rules/epic.md +497 -497
  408. package/augment-extensions/writing-standards/screenplay/styles/rules/experimental.md +492 -492
  409. package/augment-extensions/writing-standards/screenplay/styles/rules/flashback.md +509 -509
  410. package/augment-extensions/writing-standards/screenplay/styles/rules/linear.md +490 -490
  411. package/augment-extensions/writing-standards/screenplay/styles/rules/minimalist.md +499 -499
  412. package/augment-extensions/writing-standards/screenplay/styles/rules/non-linear.md +501 -501
  413. package/augment-extensions/writing-standards/screenplay/styles/rules/poetic.md +499 -499
  414. package/augment-extensions/writing-standards/screenplay/styles/rules/realistic.md +498 -498
  415. package/augment-extensions/writing-standards/screenplay/styles/rules/satirical.md +499 -499
  416. package/augment-extensions/writing-standards/screenplay/styles/rules/surreal.md +508 -508
  417. package/augment-extensions/writing-standards/screenplay/styles/rules/voice-over.md +500 -500
  418. package/augment-extensions/writing-standards/screenplay/themes/README.md +158 -158
  419. package/augment-extensions/writing-standards/screenplay/themes/examples/.gitkeep +2 -2
  420. package/augment-extensions/writing-standards/screenplay/themes/examples/common-mistakes-and-fixes.md +643 -643
  421. package/augment-extensions/writing-standards/screenplay/themes/examples/complete-scene-example.md +311 -311
  422. package/augment-extensions/writing-standards/screenplay/themes/examples/individual-theme-examples.md +562 -562
  423. package/augment-extensions/writing-standards/screenplay/themes/examples/multi-theme-weaving.md +538 -538
  424. package/augment-extensions/writing-standards/screenplay/themes/examples/theme-application-guide.md +432 -432
  425. package/augment-extensions/writing-standards/screenplay/themes/examples/theme-integration-across-acts.md +637 -637
  426. package/augment-extensions/writing-standards/screenplay/themes/module.json +66 -66
  427. package/augment-extensions/writing-standards/screenplay/themes/rules/.gitkeep +2 -2
  428. package/augment-extensions/writing-standards/screenplay/themes/rules/ambition.md +458 -458
  429. package/augment-extensions/writing-standards/screenplay/themes/rules/betrayal.md +490 -490
  430. package/augment-extensions/writing-standards/screenplay/themes/rules/environment.md +458 -458
  431. package/augment-extensions/writing-standards/screenplay/themes/rules/fate.md +459 -459
  432. package/augment-extensions/writing-standards/screenplay/themes/rules/friendship.md +491 -491
  433. package/augment-extensions/writing-standards/screenplay/themes/rules/growth.md +491 -491
  434. package/augment-extensions/writing-standards/screenplay/themes/rules/identity.md +490 -490
  435. package/augment-extensions/writing-standards/screenplay/themes/rules/isolation.md +464 -464
  436. package/augment-extensions/writing-standards/screenplay/themes/rules/justice.md +461 -461
  437. package/augment-extensions/writing-standards/screenplay/themes/rules/love.md +489 -489
  438. package/augment-extensions/writing-standards/screenplay/themes/rules/power.md +494 -494
  439. package/augment-extensions/writing-standards/screenplay/themes/rules/redemption.md +483 -483
  440. package/augment-extensions/writing-standards/screenplay/themes/rules/revenge.md +489 -489
  441. package/augment-extensions/writing-standards/screenplay/themes/rules/survival.md +496 -496
  442. package/augment-extensions/writing-standards/screenplay/themes/rules/technology.md +463 -463
  443. package/augment-extensions/writing-standards/screenplay/utils/__tests__/file-organization.test.ts +169 -0
  444. package/augment-extensions/writing-standards/screenplay/utils/file-organization.ts +165 -0
  445. package/cli/MODULES.md +302 -302
  446. package/cli/dist/cli.js +109 -22
  447. package/cli/dist/cli.js.map +1 -1
  448. package/cli/dist/commands/gui.d.ts.map +1 -1
  449. package/cli/dist/commands/gui.js +54 -6
  450. package/cli/dist/commands/gui.js.map +1 -1
  451. package/cli/dist/commands/init.d.ts.map +1 -1
  452. package/cli/dist/commands/init.js +76 -23
  453. package/cli/dist/commands/init.js.map +1 -1
  454. package/cli/dist/commands/self-remove.d.ts.map +1 -1
  455. package/cli/dist/commands/self-remove.js +48 -74
  456. package/cli/dist/commands/self-remove.js.map +1 -1
  457. package/cli/dist/commands/show.d.ts +11 -0
  458. package/cli/dist/commands/show.d.ts.map +1 -1
  459. package/cli/dist/commands/show.js +120 -0
  460. package/cli/dist/commands/show.js.map +1 -1
  461. package/cli/dist/commands/showCompleted.d.ts +21 -0
  462. package/cli/dist/commands/showCompleted.d.ts.map +1 -0
  463. package/cli/dist/commands/showCompleted.js +225 -0
  464. package/cli/dist/commands/showCompleted.js.map +1 -0
  465. package/cli/dist/commands/skill.js +88 -88
  466. package/cli/dist/commands/update.d.ts +2 -0
  467. package/cli/dist/commands/update.d.ts.map +1 -1
  468. package/cli/dist/commands/update.js +67 -1
  469. package/cli/dist/commands/update.js.map +1 -1
  470. package/cli/dist/utils/beadsCompletedChecker.d.ts +72 -0
  471. package/cli/dist/utils/beadsCompletedChecker.d.ts.map +1 -0
  472. package/cli/dist/utils/beadsCompletedChecker.js +198 -0
  473. package/cli/dist/utils/beadsCompletedChecker.js.map +1 -0
  474. package/cli/dist/utils/catalog-sync.js +13 -13
  475. package/cli/dist/utils/extractCommandHelp.d.ts +51 -0
  476. package/cli/dist/utils/extractCommandHelp.d.ts.map +1 -0
  477. package/cli/dist/utils/extractCommandHelp.js +250 -0
  478. package/cli/dist/utils/extractCommandHelp.js.map +1 -0
  479. package/cli/dist/utils/install-rules.js +55 -55
  480. package/cli/dist/utils/mcp-integration.js +44 -44
  481. package/cli/dist/utils/rule-install-hooks.js +8 -8
  482. package/modules.md +667 -630
  483. package/package.json +85 -85
@@ -1,607 +1,607 @@
1
- # Task Generation Guidelines
2
-
3
- ## Overview
4
-
5
- This document provides comprehensive guidelines for AI-driven task generation. It defines the task template structure, required sections, quality checklist, and minimum detail requirements to ensure tasks are never bare-minimum skeletons.
6
-
7
- ## 1. Comprehensive Task Template Structure
8
-
9
- ### 1.1 Complete Task Template
10
-
11
- ```markdown
12
- # Task: [Title]
13
-
14
- ## Description
15
-
16
- [Comprehensive explanation of what needs to be done, why it's needed, and what the expected outcome is]
17
-
18
- ## Context
19
-
20
- [Background information, related features, and how this task fits into the larger project]
21
-
22
- ## Prerequisites
23
-
24
- - [ ] Prerequisite 1 with specific details
25
- - [ ] Prerequisite 2 with specific details
26
- - [ ] Prerequisite 3 with specific details
27
-
28
- ## Inputs
29
-
30
- - **Input 1**: [Description and format]
31
- - **Input 2**: [Description and format]
32
-
33
- ## Outputs
34
-
35
- - **Output 1**: [Description and format]
36
- - **Output 2**: [Description and format]
37
-
38
- ## Steps
39
-
40
- 1. **Step 1**: [Detailed description]
41
- - Sub-step 1.1
42
- - Sub-step 1.2
43
-
44
- 2. **Step 2**: [Detailed description]
45
- - Sub-step 2.1
46
- - Sub-step 2.2
47
-
48
- 3. **Step 3**: [Detailed description]
49
- - Sub-step 3.1
50
- - Sub-step 3.2
51
-
52
- ## Dependencies
53
-
54
- ### Blocks (must complete before this task)
55
- - `bd-xyz`: [Task title and reason for dependency]
56
-
57
- ### Blocked By (tasks that depend on this)
58
- - `bd-abc`: [Task title and reason for dependency]
59
-
60
- ### Related
61
- - `bd-def`: [Task title and relationship]
62
-
63
- ## Edge Cases
64
-
65
- ### Case 1: [Scenario description]
66
- - **Condition**: [When this occurs]
67
- - **Handling**: [How to handle it]
68
- - **Expected Outcome**: [What should happen]
69
-
70
- ### Case 2: [Scenario description]
71
- - **Condition**: [When this occurs]
72
- - **Handling**: [How to handle it]
73
- - **Expected Outcome**: [What should happen]
74
-
75
- ## Error Handling
76
-
77
- ### Error 1: [Error description]
78
- - **Cause**: [What causes this error]
79
- - **Detection**: [How to detect it]
80
- - **Resolution**: [How to fix it]
81
- - **Prevention**: [How to prevent it]
82
-
83
- ## Verification
84
-
85
- - [ ] Verification criterion 1 with specific test
86
- - [ ] Verification criterion 2 with specific test
87
- - [ ] Verification criterion 3 with specific test
88
-
89
- ## Success Metrics
90
-
91
- - **Metric 1**: [Measurable outcome with target value]
92
- - **Metric 2**: [Measurable outcome with target value]
93
- - **Metric 3**: [Measurable outcome with target value]
94
-
95
- ## Testing
96
-
97
- ### Unit Tests
98
- - Test 1: [Description]
99
- - Test 2: [Description]
100
-
101
- ### Integration Tests
102
- - Test 1: [Description]
103
- - Test 2: [Description]
104
-
105
- ## Documentation
106
-
107
- - [ ] Code comments added
108
- - [ ] API documentation updated
109
- - [ ] User guide updated (if applicable)
110
- - [ ] README updated (if applicable)
111
-
112
- ## Rollback Plan
113
-
114
- 1. Step 1 to rollback changes
115
- 2. Step 2 to rollback changes
116
- 3. Verification that rollback was successful
117
-
118
- ## Estimated Effort
119
-
120
- - **Time**: [Estimated hours/days]
121
- - **Complexity**: [Low/Medium/High]
122
- - **Risk**: [Low/Medium/High]
123
-
124
- ## Resources
125
-
126
- - [Link to relevant documentation]
127
- - [Link to related code]
128
- - [Link to design documents]
129
- ```
130
-
131
- ## 2. Required Sections
132
-
133
- ### 2.1 Mandatory Sections
134
-
135
- Every task MUST include:
136
-
137
- 1. **Title**: Action-oriented, specific
138
- 2. **Description**: Comprehensive explanation
139
- 3. **Prerequisites**: What must be ready first
140
- 4. **Steps**: Detailed, ordered actions
141
- 5. **Verification**: Clear completion criteria
142
- 6. **Success Metrics**: Measurable outcomes
143
-
144
- ### 2.2 Highly Recommended Sections
145
-
146
- Tasks SHOULD include:
147
-
148
- 1. **Context**: Background and project fit
149
- 2. **Inputs/Outputs**: Data flow
150
- 3. **Dependencies**: Task relationships
151
- 4. **Edge Cases**: Special scenarios
152
- 5. **Error Handling**: Failure modes
153
- 6. **Testing**: Test requirements
154
- 7. **Documentation**: Doc updates needed
155
-
156
- ### 2.3 Optional Sections
157
-
158
- Tasks MAY include:
159
-
160
- 1. **Rollback Plan**: How to undo changes
161
- 2. **Estimated Effort**: Time and complexity
162
- 3. **Resources**: Links and references
163
-
164
- ## 3. Quality Checklist
165
-
166
- ### 3.1 Before Creating a Task
167
-
168
- - [ ] Is the task title clear and action-oriented?
169
- - [ ] Does the description explain WHAT, WHY, and EXPECTED OUTCOME?
170
- - [ ] Are all prerequisites explicitly listed?
171
- - [ ] Are steps detailed enough to execute without additional research?
172
- - [ ] Are verification criteria specific and testable?
173
- - [ ] Are success metrics measurable?
174
- - [ ] Are dependencies properly declared?
175
- - [ ] Are edge cases documented?
176
- - [ ] Is error handling addressed?
177
-
178
- ### 3.2 After Creating a Task
179
-
180
- - [ ] Can someone unfamiliar with the project understand the task?
181
- - [ ] Is all necessary information present?
182
- - [ ] Are there no ambiguous terms or vague instructions?
183
- - [ ] Is the task properly scoped (not too large, not too small)?
184
- - [ ] Are all links and references valid?
185
-
186
- ## 4. Minimum Detail Requirements
187
-
188
- ### 4.1 NO Bare-Minimum Skeletons
189
-
190
- **NEVER create tasks like this**:
191
-
192
- ```markdown
193
- # Task: Implement feature X
194
-
195
- ## Description
196
- Implement feature X
197
-
198
- ## Steps
199
- 1. Do the thing
200
- 2. Test it
201
- 3. Done
202
- ```
203
-
204
- This is UNACCEPTABLE. It provides no value and wastes time.
205
-
206
- ### 4.2 Minimum Acceptable Detail
207
-
208
- **ALWAYS create tasks like this**:
209
-
210
- ```markdown
211
- # Task: Implement user search functionality
212
-
213
- ## Description
214
- Implement a search feature that allows users to search for other users by name, email, or username. The search should support partial matching, be case-insensitive, and return results in real-time as the user types.
215
-
216
- ## Prerequisites
217
- - [ ] User database schema includes searchable fields (name, email, username)
218
- - [ ] Search API endpoint design approved
219
- - [ ] Frontend search component design completed
220
-
221
- ## Steps
222
- 1. **Create search API endpoint**
223
- - Add GET /api/users/search route
224
- - Implement query parameter parsing (q=search_term)
225
- - Add pagination support (page, limit)
226
-
227
- 2. **Implement search logic**
228
- - Use database LIKE query for partial matching
229
- - Make search case-insensitive (LOWER function)
230
- - Search across name, email, and username fields
231
- - Order results by relevance (exact matches first)
232
-
233
- 3. **Add real-time search to frontend**
234
- - Create SearchInput component with debouncing (300ms)
235
- - Implement API call on input change
236
- - Display results in dropdown
237
- - Handle loading and error states
238
-
239
- ## Verification
240
- - [ ] Search returns correct results for exact matches
241
- - [ ] Search returns correct results for partial matches
242
- - [ ] Search is case-insensitive
243
- - [ ] Results update in real-time with debouncing
244
- - [ ] Pagination works correctly
245
- - [ ] Empty search returns no results
246
- - [ ] Invalid queries handled gracefully
247
-
248
- ## Success Metrics
249
- - Search response time < 200ms for queries
250
- - Search accuracy > 95% for partial matches
251
- - Zero errors in production for 7 days
252
- ```
253
-
254
- ## 5. Task Generation Examples
255
-
256
- ### 5.1 Basic Task Example
257
-
258
- See section 4.2 above for a basic task example.
259
-
260
- ### 5.2 Intermediate Task Example
261
-
262
- ```markdown
263
- # Task: Implement caching layer for API responses
264
-
265
- ## Description
266
- Add a Redis-based caching layer to improve API response times for frequently accessed endpoints. Cache should support TTL, cache invalidation, and cache warming.
267
-
268
- ## Context
269
- Current API response times are 500-800ms for user profile requests. Target is < 100ms. Caching will reduce database load and improve user experience.
270
-
271
- ## Prerequisites
272
- - [ ] Redis server installed and configured
273
- - [ ] Redis client library added to project
274
- - [ ] Cache configuration schema defined
275
- - [ ] Monitoring tools configured for cache metrics
276
-
277
- ## Inputs
278
- - API request (endpoint, parameters)
279
- - Cache configuration (TTL, invalidation rules)
280
-
281
- ## Outputs
282
- - Cached response (if available)
283
- - Fresh response from database (if cache miss)
284
- - Cache metrics (hit rate, miss rate)
285
-
286
- ## Steps
287
- 1. **Install and configure Redis client**
288
- - Add redis npm package
289
- - Create Redis connection manager
290
- - Configure connection pooling
291
- - Add error handling for connection failures
292
-
293
- 2. **Implement cache middleware**
294
- - Create cache middleware function
295
- - Check cache before database query
296
- - Return cached response if available
297
- - Store fresh response in cache if miss
298
- - Add cache headers to response
299
-
300
- 3. **Implement cache invalidation**
301
- - Invalidate cache on data updates
302
- - Support pattern-based invalidation
303
- - Add manual invalidation endpoint
304
- - Log invalidation events
305
-
306
- 4. **Add cache warming**
307
- - Identify frequently accessed data
308
- - Pre-populate cache on server start
309
- - Schedule periodic cache refresh
310
- - Monitor cache warming effectiveness
311
-
312
- ## Dependencies
313
- ### Blocks
314
- - `bd-redis-setup`: Redis server must be configured
315
-
316
- ### Related
317
- - `bd-monitoring`: Cache metrics should be monitored
318
-
319
- ## Edge Cases
320
- ### Case 1: Redis connection failure
321
- - **Condition**: Redis server unavailable
322
- - **Handling**: Fall back to database, log error
323
- - **Expected Outcome**: API continues to work, slower response times
324
-
325
- ### Case 2: Cache stampede
326
- - **Condition**: Many requests for expired cache key
327
- - **Handling**: Use cache locking to prevent multiple DB queries
328
- - **Expected Outcome**: Only one DB query executed
329
-
330
- ## Error Handling
331
- ### Error 1: Redis connection timeout
332
- - **Cause**: Network issues or Redis overload
333
- - **Detection**: Connection timeout exception
334
- - **Resolution**: Retry with exponential backoff, fall back to DB
335
- - **Prevention**: Monitor Redis health, scale if needed
336
-
337
- ## Verification
338
- - [ ] Cache hit rate > 80% for user profiles
339
- - [ ] Response time < 100ms for cached requests
340
- - [ ] Cache invalidation works on data updates
341
- - [ ] System handles Redis failures gracefully
342
- - [ ] Cache warming completes successfully on startup
343
-
344
- ## Success Metrics
345
- - **Response Time**: < 100ms for cached requests (target: 50ms)
346
- - **Cache Hit Rate**: > 80% (target: 90%)
347
- - **Database Load**: Reduced by 70%
348
-
349
- ## Testing
350
- ### Unit Tests
351
- - Cache middleware returns cached data
352
- - Cache middleware stores fresh data
353
- - Cache invalidation removes correct keys
354
- - Error handling works for Redis failures
355
-
356
- ### Integration Tests
357
- - End-to-end caching for user profiles
358
- - Cache invalidation on profile updates
359
- - Cache warming on server start
360
- - Fallback to database on Redis failure
361
-
362
- ## Documentation
363
- - [ ] Cache configuration documented
364
- - [ ] Cache invalidation patterns documented
365
- - [ ] Monitoring dashboard created
366
- - [ ] Runbook for cache issues created
367
-
368
- ## Rollback Plan
369
- 1. Disable cache middleware via feature flag
370
- 2. Verify API works without cache
371
- 3. Monitor response times and database load
372
- 4. Investigate and fix cache issues
373
- 5. Re-enable cache when ready
374
-
375
- ## Estimated Effort
376
- - **Time**: 8-12 hours
377
- - **Complexity**: Medium
378
- - **Risk**: Medium (Redis dependency)
379
-
380
- ## Resources
381
- - [Redis documentation](https://redis.io/docs/)
382
- - [Cache invalidation patterns](https://example.com/cache-patterns)
383
- - [Monitoring dashboard](https://example.com/monitoring)
384
- ```
385
-
386
- ### 5.3 Advanced Task Example
387
-
388
- ```markdown
389
- # Task: Implement distributed transaction coordinator for microservices
390
-
391
- ## Description
392
- Build a distributed transaction coordinator using the Saga pattern to ensure data consistency across multiple microservices (User, Order, Payment, Inventory). The coordinator should handle both successful transactions and compensating transactions for failures.
393
-
394
- ## Context
395
- Current system has data inconsistency issues when orders fail after payment is processed. Need a robust distributed transaction mechanism to ensure all-or-nothing semantics across services.
396
-
397
- ## Prerequisites
398
- - [ ] All microservices expose transaction APIs (commit, rollback)
399
- - [ ] Message queue (RabbitMQ/Kafka) configured
400
- - [ ] Transaction state database schema created
401
- - [ ] Monitoring and alerting configured
402
- - [ ] Circuit breaker pattern implemented in all services
403
-
404
- ## Inputs
405
- - **Transaction Request**: Order details, user ID, payment info
406
- - **Service Endpoints**: URLs for all participating services
407
- - **Compensation Logic**: Rollback procedures for each service
408
-
409
- ## Outputs
410
- - **Transaction Result**: Success or failure with details
411
- - **Transaction Log**: Complete audit trail
412
- - **Compensation Events**: Rollback actions if needed
413
-
414
- ## Steps
415
- 1. **Design Saga orchestration**
416
- - Define transaction steps (create order → reserve inventory → process payment → confirm order)
417
- - Define compensation steps (cancel order → release inventory → refund payment)
418
- - Create state machine for transaction flow
419
- - Document failure scenarios and recovery paths
420
-
421
- 2. **Implement transaction coordinator**
422
- - Create Coordinator service with state management
423
- - Implement step execution with retry logic
424
- - Add timeout handling for each step
425
- - Store transaction state in database
426
- - Implement idempotency for all operations
427
-
428
- 3. **Implement compensation logic**
429
- - Create compensation handlers for each step
430
- - Implement reverse order execution
431
- - Add compensation retry logic
432
- - Log all compensation actions
433
- - Handle partial compensation failures
434
-
435
- 4. **Add monitoring and observability**
436
- - Instrument all transaction steps
437
- - Add distributed tracing (OpenTelemetry)
438
- - Create dashboards for transaction metrics
439
- - Set up alerts for failures
440
- - Log all state transitions
441
-
442
- 5. **Implement recovery mechanisms**
443
- - Add crash recovery for coordinator
444
- - Implement transaction replay from logs
445
- - Handle orphaned transactions
446
- - Add manual intervention endpoints
447
- - Create admin UI for transaction management
448
-
449
- ## Dependencies
450
- ### Blocks
451
- - `bd-msg-queue`: Message queue must be configured
452
- - `bd-circuit-breaker`: Circuit breakers must be implemented
453
- - `bd-tracing`: Distributed tracing must be set up
454
-
455
- ### Blocked By
456
- - `bd-order-api`: Order service transaction API
457
- - `bd-payment-api`: Payment service transaction API
458
- - `bd-inventory-api`: Inventory service transaction API
459
-
460
- ### Related
461
- - `bd-monitoring`: Transaction metrics monitoring
462
- - `bd-alerting`: Failure alerting system
463
-
464
- ## Edge Cases
465
- ### Case 1: Service timeout during transaction
466
- - **Condition**: Service doesn't respond within timeout
467
- - **Handling**: Mark step as failed, initiate compensation
468
- - **Expected Outcome**: Transaction rolled back, user notified
469
-
470
- ### Case 2: Compensation failure
471
- - **Condition**: Compensation step fails (e.g., refund fails)
472
- - **Handling**: Retry with exponential backoff, alert on-call
473
- - **Expected Outcome**: Manual intervention triggered
474
-
475
- ### Case 3: Coordinator crash mid-transaction
476
- - **Condition**: Coordinator crashes during execution
477
- - **Handling**: Recover from transaction log on restart
478
- - **Expected Outcome**: Transaction resumed or compensated
479
-
480
- ### Case 4: Network partition
481
- - **Condition**: Network split between services
482
- - **Handling**: Use timeouts and circuit breakers
483
- - **Expected Outcome**: Transaction fails safely, no partial commits
484
-
485
- ## Error Handling
486
- ### Error 1: Service unavailable
487
- - **Cause**: Service down or unreachable
488
- - **Detection**: Connection timeout or 503 response
489
- - **Resolution**: Retry with backoff, then compensate
490
- - **Prevention**: Health checks, circuit breakers
491
-
492
- ### Error 2: Duplicate transaction
493
- - **Cause**: Client retry or network issue
494
- - **Detection**: Transaction ID already exists
495
- - **Resolution**: Return existing transaction result
496
- - **Prevention**: Idempotency keys
497
-
498
- ### Error 3: Inconsistent state
499
- - **Cause**: Compensation partially failed
500
- - **Detection**: State machine in invalid state
501
- - **Resolution**: Manual intervention via admin UI
502
- - **Prevention**: Atomic state updates, transaction logs
503
-
504
- ## Verification
505
- - [ ] Successful transaction commits all services
506
- - [ ] Failed transaction compensates all completed steps
507
- - [ ] Duplicate requests are idempotent
508
- - [ ] Coordinator recovers from crashes
509
- - [ ] Timeouts trigger compensation
510
- - [ ] Circuit breakers prevent cascading failures
511
- - [ ] All transactions logged completely
512
- - [ ] Monitoring shows all transaction states
513
- - [ ] Alerts fire for failures
514
-
515
- ## Success Metrics
516
- - **Transaction Success Rate**: > 99.9%
517
- - **Compensation Success Rate**: > 99.5%
518
- - **Transaction Latency**: < 2 seconds (p95)
519
- - **Recovery Time**: < 30 seconds after coordinator crash
520
- - **Data Consistency**: 100% (no orphaned transactions)
521
-
522
- ## Testing
523
- ### Unit Tests
524
- - State machine transitions correctly
525
- - Compensation logic executes in reverse order
526
- - Idempotency prevents duplicate execution
527
- - Timeout handling works correctly
528
- - Retry logic with exponential backoff
529
-
530
- ### Integration Tests
531
- - End-to-end successful transaction
532
- - End-to-end failed transaction with compensation
533
- - Coordinator crash recovery
534
- - Service timeout handling
535
- - Network partition handling
536
- - Duplicate request handling
537
-
538
- ### Chaos Tests
539
- - Random service failures
540
- - Network delays and partitions
541
- - Coordinator crashes at various points
542
- - Database failures
543
- - Message queue failures
544
-
545
- ## Documentation
546
- - [ ] Saga pattern architecture documented
547
- - [ ] State machine diagram created
548
- - [ ] API documentation for coordinator
549
- - [ ] Runbook for common failures
550
- - [ ] Admin UI user guide
551
- - [ ] Monitoring dashboard guide
552
-
553
- ## Rollback Plan
554
- 1. Disable new transaction creation via feature flag
555
- 2. Allow in-flight transactions to complete
556
- 3. Monitor for orphaned transactions
557
- 4. Manually resolve any inconsistencies
558
- 5. Revert to previous transaction mechanism
559
- 6. Investigate and fix issues
560
- 7. Re-enable when ready
561
-
562
- ## Estimated Effort
563
- - **Time**: 40-60 hours (2-3 weeks)
564
- - **Complexity**: High
565
- - **Risk**: High (distributed systems complexity)
566
-
567
- ## Resources
568
- - [Saga pattern documentation](https://microservices.io/patterns/data/saga.html)
569
- - [Distributed transactions guide](https://example.com/distributed-tx)
570
- - [OpenTelemetry tracing](https://opentelemetry.io/)
571
- - [Circuit breaker pattern](https://example.com/circuit-breaker)
572
- - [Transaction coordinator design doc](https://example.com/design-doc)
573
- ```
574
-
575
- ## 6. Anti-Patterns (What NOT to Do)
576
-
577
- ### 6.1 Vague Descriptions
578
-
579
- ❌ **BAD**: "Fix the bug"
580
- ✅ **GOOD**: "Fix null pointer exception in user profile page when user has no avatar"
581
-
582
- ### 6.2 Missing Context
583
-
584
- ❌ **BAD**: "Update the API"
585
- ✅ **GOOD**: "Update user API to include profile picture URL in response payload"
586
-
587
- ### 6.3 No Verification
588
-
589
- ❌ **BAD**: Steps listed, no verification
590
- ✅ **GOOD**: Clear, testable verification criteria for each requirement
591
-
592
- ### 6.4 Unclear Dependencies
593
-
594
- ❌ **BAD**: "Depends on other stuff"
595
- ✅ **GOOD**: "Blocks: bd-auth (user authentication must be complete before profile features)"
596
-
597
- ### 6.5 No Error Handling
598
-
599
- ❌ **BAD**: Happy path only
600
- ✅ **GOOD**: Document known failure modes and how to handle them
601
-
602
- ## Summary
603
-
604
- Task generation is NOT about creating quick skeletons. It's about creating comprehensive, actionable, and complete task descriptions that enable efficient execution without additional research or clarification.
605
-
606
- **Remember**: Time spent creating a detailed task saves 10x the time during execution.
607
-
1
+ # Task Generation Guidelines
2
+
3
+ ## Overview
4
+
5
+ This document provides comprehensive guidelines for AI-driven task generation. It defines the task template structure, required sections, quality checklist, and minimum detail requirements to ensure tasks are never bare-minimum skeletons.
6
+
7
+ ## 1. Comprehensive Task Template Structure
8
+
9
+ ### 1.1 Complete Task Template
10
+
11
+ ```markdown
12
+ # Task: [Title]
13
+
14
+ ## Description
15
+
16
+ [Comprehensive explanation of what needs to be done, why it's needed, and what the expected outcome is]
17
+
18
+ ## Context
19
+
20
+ [Background information, related features, and how this task fits into the larger project]
21
+
22
+ ## Prerequisites
23
+
24
+ - [ ] Prerequisite 1 with specific details
25
+ - [ ] Prerequisite 2 with specific details
26
+ - [ ] Prerequisite 3 with specific details
27
+
28
+ ## Inputs
29
+
30
+ - **Input 1**: [Description and format]
31
+ - **Input 2**: [Description and format]
32
+
33
+ ## Outputs
34
+
35
+ - **Output 1**: [Description and format]
36
+ - **Output 2**: [Description and format]
37
+
38
+ ## Steps
39
+
40
+ 1. **Step 1**: [Detailed description]
41
+ - Sub-step 1.1
42
+ - Sub-step 1.2
43
+
44
+ 2. **Step 2**: [Detailed description]
45
+ - Sub-step 2.1
46
+ - Sub-step 2.2
47
+
48
+ 3. **Step 3**: [Detailed description]
49
+ - Sub-step 3.1
50
+ - Sub-step 3.2
51
+
52
+ ## Dependencies
53
+
54
+ ### Blocks (must complete before this task)
55
+ - `bd-xyz`: [Task title and reason for dependency]
56
+
57
+ ### Blocked By (tasks that depend on this)
58
+ - `bd-abc`: [Task title and reason for dependency]
59
+
60
+ ### Related
61
+ - `bd-def`: [Task title and relationship]
62
+
63
+ ## Edge Cases
64
+
65
+ ### Case 1: [Scenario description]
66
+ - **Condition**: [When this occurs]
67
+ - **Handling**: [How to handle it]
68
+ - **Expected Outcome**: [What should happen]
69
+
70
+ ### Case 2: [Scenario description]
71
+ - **Condition**: [When this occurs]
72
+ - **Handling**: [How to handle it]
73
+ - **Expected Outcome**: [What should happen]
74
+
75
+ ## Error Handling
76
+
77
+ ### Error 1: [Error description]
78
+ - **Cause**: [What causes this error]
79
+ - **Detection**: [How to detect it]
80
+ - **Resolution**: [How to fix it]
81
+ - **Prevention**: [How to prevent it]
82
+
83
+ ## Verification
84
+
85
+ - [ ] Verification criterion 1 with specific test
86
+ - [ ] Verification criterion 2 with specific test
87
+ - [ ] Verification criterion 3 with specific test
88
+
89
+ ## Success Metrics
90
+
91
+ - **Metric 1**: [Measurable outcome with target value]
92
+ - **Metric 2**: [Measurable outcome with target value]
93
+ - **Metric 3**: [Measurable outcome with target value]
94
+
95
+ ## Testing
96
+
97
+ ### Unit Tests
98
+ - Test 1: [Description]
99
+ - Test 2: [Description]
100
+
101
+ ### Integration Tests
102
+ - Test 1: [Description]
103
+ - Test 2: [Description]
104
+
105
+ ## Documentation
106
+
107
+ - [ ] Code comments added
108
+ - [ ] API documentation updated
109
+ - [ ] User guide updated (if applicable)
110
+ - [ ] README updated (if applicable)
111
+
112
+ ## Rollback Plan
113
+
114
+ 1. Step 1 to rollback changes
115
+ 2. Step 2 to rollback changes
116
+ 3. Verification that rollback was successful
117
+
118
+ ## Estimated Effort
119
+
120
+ - **Time**: [Estimated hours/days]
121
+ - **Complexity**: [Low/Medium/High]
122
+ - **Risk**: [Low/Medium/High]
123
+
124
+ ## Resources
125
+
126
+ - [Link to relevant documentation]
127
+ - [Link to related code]
128
+ - [Link to design documents]
129
+ ```
130
+
131
+ ## 2. Required Sections
132
+
133
+ ### 2.1 Mandatory Sections
134
+
135
+ Every task MUST include:
136
+
137
+ 1. **Title**: Action-oriented, specific
138
+ 2. **Description**: Comprehensive explanation
139
+ 3. **Prerequisites**: What must be ready first
140
+ 4. **Steps**: Detailed, ordered actions
141
+ 5. **Verification**: Clear completion criteria
142
+ 6. **Success Metrics**: Measurable outcomes
143
+
144
+ ### 2.2 Highly Recommended Sections
145
+
146
+ Tasks SHOULD include:
147
+
148
+ 1. **Context**: Background and project fit
149
+ 2. **Inputs/Outputs**: Data flow
150
+ 3. **Dependencies**: Task relationships
151
+ 4. **Edge Cases**: Special scenarios
152
+ 5. **Error Handling**: Failure modes
153
+ 6. **Testing**: Test requirements
154
+ 7. **Documentation**: Doc updates needed
155
+
156
+ ### 2.3 Optional Sections
157
+
158
+ Tasks MAY include:
159
+
160
+ 1. **Rollback Plan**: How to undo changes
161
+ 2. **Estimated Effort**: Time and complexity
162
+ 3. **Resources**: Links and references
163
+
164
+ ## 3. Quality Checklist
165
+
166
+ ### 3.1 Before Creating a Task
167
+
168
+ - [ ] Is the task title clear and action-oriented?
169
+ - [ ] Does the description explain WHAT, WHY, and EXPECTED OUTCOME?
170
+ - [ ] Are all prerequisites explicitly listed?
171
+ - [ ] Are steps detailed enough to execute without additional research?
172
+ - [ ] Are verification criteria specific and testable?
173
+ - [ ] Are success metrics measurable?
174
+ - [ ] Are dependencies properly declared?
175
+ - [ ] Are edge cases documented?
176
+ - [ ] Is error handling addressed?
177
+
178
+ ### 3.2 After Creating a Task
179
+
180
+ - [ ] Can someone unfamiliar with the project understand the task?
181
+ - [ ] Is all necessary information present?
182
+ - [ ] Are there no ambiguous terms or vague instructions?
183
+ - [ ] Is the task properly scoped (not too large, not too small)?
184
+ - [ ] Are all links and references valid?
185
+
186
+ ## 4. Minimum Detail Requirements
187
+
188
+ ### 4.1 NO Bare-Minimum Skeletons
189
+
190
+ **NEVER create tasks like this**:
191
+
192
+ ```markdown
193
+ # Task: Implement feature X
194
+
195
+ ## Description
196
+ Implement feature X
197
+
198
+ ## Steps
199
+ 1. Do the thing
200
+ 2. Test it
201
+ 3. Done
202
+ ```
203
+
204
+ This is UNACCEPTABLE. It provides no value and wastes time.
205
+
206
+ ### 4.2 Minimum Acceptable Detail
207
+
208
+ **ALWAYS create tasks like this**:
209
+
210
+ ```markdown
211
+ # Task: Implement user search functionality
212
+
213
+ ## Description
214
+ Implement a search feature that allows users to search for other users by name, email, or username. The search should support partial matching, be case-insensitive, and return results in real-time as the user types.
215
+
216
+ ## Prerequisites
217
+ - [ ] User database schema includes searchable fields (name, email, username)
218
+ - [ ] Search API endpoint design approved
219
+ - [ ] Frontend search component design completed
220
+
221
+ ## Steps
222
+ 1. **Create search API endpoint**
223
+ - Add GET /api/users/search route
224
+ - Implement query parameter parsing (q=search_term)
225
+ - Add pagination support (page, limit)
226
+
227
+ 2. **Implement search logic**
228
+ - Use database LIKE query for partial matching
229
+ - Make search case-insensitive (LOWER function)
230
+ - Search across name, email, and username fields
231
+ - Order results by relevance (exact matches first)
232
+
233
+ 3. **Add real-time search to frontend**
234
+ - Create SearchInput component with debouncing (300ms)
235
+ - Implement API call on input change
236
+ - Display results in dropdown
237
+ - Handle loading and error states
238
+
239
+ ## Verification
240
+ - [ ] Search returns correct results for exact matches
241
+ - [ ] Search returns correct results for partial matches
242
+ - [ ] Search is case-insensitive
243
+ - [ ] Results update in real-time with debouncing
244
+ - [ ] Pagination works correctly
245
+ - [ ] Empty search returns no results
246
+ - [ ] Invalid queries handled gracefully
247
+
248
+ ## Success Metrics
249
+ - Search response time < 200ms for queries
250
+ - Search accuracy > 95% for partial matches
251
+ - Zero errors in production for 7 days
252
+ ```
253
+
254
+ ## 5. Task Generation Examples
255
+
256
+ ### 5.1 Basic Task Example
257
+
258
+ See section 4.2 above for a basic task example.
259
+
260
+ ### 5.2 Intermediate Task Example
261
+
262
+ ```markdown
263
+ # Task: Implement caching layer for API responses
264
+
265
+ ## Description
266
+ Add a Redis-based caching layer to improve API response times for frequently accessed endpoints. Cache should support TTL, cache invalidation, and cache warming.
267
+
268
+ ## Context
269
+ Current API response times are 500-800ms for user profile requests. Target is < 100ms. Caching will reduce database load and improve user experience.
270
+
271
+ ## Prerequisites
272
+ - [ ] Redis server installed and configured
273
+ - [ ] Redis client library added to project
274
+ - [ ] Cache configuration schema defined
275
+ - [ ] Monitoring tools configured for cache metrics
276
+
277
+ ## Inputs
278
+ - API request (endpoint, parameters)
279
+ - Cache configuration (TTL, invalidation rules)
280
+
281
+ ## Outputs
282
+ - Cached response (if available)
283
+ - Fresh response from database (if cache miss)
284
+ - Cache metrics (hit rate, miss rate)
285
+
286
+ ## Steps
287
+ 1. **Install and configure Redis client**
288
+ - Add redis npm package
289
+ - Create Redis connection manager
290
+ - Configure connection pooling
291
+ - Add error handling for connection failures
292
+
293
+ 2. **Implement cache middleware**
294
+ - Create cache middleware function
295
+ - Check cache before database query
296
+ - Return cached response if available
297
+ - Store fresh response in cache if miss
298
+ - Add cache headers to response
299
+
300
+ 3. **Implement cache invalidation**
301
+ - Invalidate cache on data updates
302
+ - Support pattern-based invalidation
303
+ - Add manual invalidation endpoint
304
+ - Log invalidation events
305
+
306
+ 4. **Add cache warming**
307
+ - Identify frequently accessed data
308
+ - Pre-populate cache on server start
309
+ - Schedule periodic cache refresh
310
+ - Monitor cache warming effectiveness
311
+
312
+ ## Dependencies
313
+ ### Blocks
314
+ - `bd-redis-setup`: Redis server must be configured
315
+
316
+ ### Related
317
+ - `bd-monitoring`: Cache metrics should be monitored
318
+
319
+ ## Edge Cases
320
+ ### Case 1: Redis connection failure
321
+ - **Condition**: Redis server unavailable
322
+ - **Handling**: Fall back to database, log error
323
+ - **Expected Outcome**: API continues to work, slower response times
324
+
325
+ ### Case 2: Cache stampede
326
+ - **Condition**: Many requests for expired cache key
327
+ - **Handling**: Use cache locking to prevent multiple DB queries
328
+ - **Expected Outcome**: Only one DB query executed
329
+
330
+ ## Error Handling
331
+ ### Error 1: Redis connection timeout
332
+ - **Cause**: Network issues or Redis overload
333
+ - **Detection**: Connection timeout exception
334
+ - **Resolution**: Retry with exponential backoff, fall back to DB
335
+ - **Prevention**: Monitor Redis health, scale if needed
336
+
337
+ ## Verification
338
+ - [ ] Cache hit rate > 80% for user profiles
339
+ - [ ] Response time < 100ms for cached requests
340
+ - [ ] Cache invalidation works on data updates
341
+ - [ ] System handles Redis failures gracefully
342
+ - [ ] Cache warming completes successfully on startup
343
+
344
+ ## Success Metrics
345
+ - **Response Time**: < 100ms for cached requests (target: 50ms)
346
+ - **Cache Hit Rate**: > 80% (target: 90%)
347
+ - **Database Load**: Reduced by 70%
348
+
349
+ ## Testing
350
+ ### Unit Tests
351
+ - Cache middleware returns cached data
352
+ - Cache middleware stores fresh data
353
+ - Cache invalidation removes correct keys
354
+ - Error handling works for Redis failures
355
+
356
+ ### Integration Tests
357
+ - End-to-end caching for user profiles
358
+ - Cache invalidation on profile updates
359
+ - Cache warming on server start
360
+ - Fallback to database on Redis failure
361
+
362
+ ## Documentation
363
+ - [ ] Cache configuration documented
364
+ - [ ] Cache invalidation patterns documented
365
+ - [ ] Monitoring dashboard created
366
+ - [ ] Runbook for cache issues created
367
+
368
+ ## Rollback Plan
369
+ 1. Disable cache middleware via feature flag
370
+ 2. Verify API works without cache
371
+ 3. Monitor response times and database load
372
+ 4. Investigate and fix cache issues
373
+ 5. Re-enable cache when ready
374
+
375
+ ## Estimated Effort
376
+ - **Time**: 8-12 hours
377
+ - **Complexity**: Medium
378
+ - **Risk**: Medium (Redis dependency)
379
+
380
+ ## Resources
381
+ - [Redis documentation](https://redis.io/docs/)
382
+ - [Cache invalidation patterns](https://example.com/cache-patterns)
383
+ - [Monitoring dashboard](https://example.com/monitoring)
384
+ ```
385
+
386
+ ### 5.3 Advanced Task Example
387
+
388
+ ```markdown
389
+ # Task: Implement distributed transaction coordinator for microservices
390
+
391
+ ## Description
392
+ Build a distributed transaction coordinator using the Saga pattern to ensure data consistency across multiple microservices (User, Order, Payment, Inventory). The coordinator should handle both successful transactions and compensating transactions for failures.
393
+
394
+ ## Context
395
+ Current system has data inconsistency issues when orders fail after payment is processed. Need a robust distributed transaction mechanism to ensure all-or-nothing semantics across services.
396
+
397
+ ## Prerequisites
398
+ - [ ] All microservices expose transaction APIs (commit, rollback)
399
+ - [ ] Message queue (RabbitMQ/Kafka) configured
400
+ - [ ] Transaction state database schema created
401
+ - [ ] Monitoring and alerting configured
402
+ - [ ] Circuit breaker pattern implemented in all services
403
+
404
+ ## Inputs
405
+ - **Transaction Request**: Order details, user ID, payment info
406
+ - **Service Endpoints**: URLs for all participating services
407
+ - **Compensation Logic**: Rollback procedures for each service
408
+
409
+ ## Outputs
410
+ - **Transaction Result**: Success or failure with details
411
+ - **Transaction Log**: Complete audit trail
412
+ - **Compensation Events**: Rollback actions if needed
413
+
414
+ ## Steps
415
+ 1. **Design Saga orchestration**
416
+ - Define transaction steps (create order → reserve inventory → process payment → confirm order)
417
+ - Define compensation steps (cancel order → release inventory → refund payment)
418
+ - Create state machine for transaction flow
419
+ - Document failure scenarios and recovery paths
420
+
421
+ 2. **Implement transaction coordinator**
422
+ - Create Coordinator service with state management
423
+ - Implement step execution with retry logic
424
+ - Add timeout handling for each step
425
+ - Store transaction state in database
426
+ - Implement idempotency for all operations
427
+
428
+ 3. **Implement compensation logic**
429
+ - Create compensation handlers for each step
430
+ - Implement reverse order execution
431
+ - Add compensation retry logic
432
+ - Log all compensation actions
433
+ - Handle partial compensation failures
434
+
435
+ 4. **Add monitoring and observability**
436
+ - Instrument all transaction steps
437
+ - Add distributed tracing (OpenTelemetry)
438
+ - Create dashboards for transaction metrics
439
+ - Set up alerts for failures
440
+ - Log all state transitions
441
+
442
+ 5. **Implement recovery mechanisms**
443
+ - Add crash recovery for coordinator
444
+ - Implement transaction replay from logs
445
+ - Handle orphaned transactions
446
+ - Add manual intervention endpoints
447
+ - Create admin UI for transaction management
448
+
449
+ ## Dependencies
450
+ ### Blocks
451
+ - `bd-msg-queue`: Message queue must be configured
452
+ - `bd-circuit-breaker`: Circuit breakers must be implemented
453
+ - `bd-tracing`: Distributed tracing must be set up
454
+
455
+ ### Blocked By
456
+ - `bd-order-api`: Order service transaction API
457
+ - `bd-payment-api`: Payment service transaction API
458
+ - `bd-inventory-api`: Inventory service transaction API
459
+
460
+ ### Related
461
+ - `bd-monitoring`: Transaction metrics monitoring
462
+ - `bd-alerting`: Failure alerting system
463
+
464
+ ## Edge Cases
465
+ ### Case 1: Service timeout during transaction
466
+ - **Condition**: Service doesn't respond within timeout
467
+ - **Handling**: Mark step as failed, initiate compensation
468
+ - **Expected Outcome**: Transaction rolled back, user notified
469
+
470
+ ### Case 2: Compensation failure
471
+ - **Condition**: Compensation step fails (e.g., refund fails)
472
+ - **Handling**: Retry with exponential backoff, alert on-call
473
+ - **Expected Outcome**: Manual intervention triggered
474
+
475
+ ### Case 3: Coordinator crash mid-transaction
476
+ - **Condition**: Coordinator crashes during execution
477
+ - **Handling**: Recover from transaction log on restart
478
+ - **Expected Outcome**: Transaction resumed or compensated
479
+
480
+ ### Case 4: Network partition
481
+ - **Condition**: Network split between services
482
+ - **Handling**: Use timeouts and circuit breakers
483
+ - **Expected Outcome**: Transaction fails safely, no partial commits
484
+
485
+ ## Error Handling
486
+ ### Error 1: Service unavailable
487
+ - **Cause**: Service down or unreachable
488
+ - **Detection**: Connection timeout or 503 response
489
+ - **Resolution**: Retry with backoff, then compensate
490
+ - **Prevention**: Health checks, circuit breakers
491
+
492
+ ### Error 2: Duplicate transaction
493
+ - **Cause**: Client retry or network issue
494
+ - **Detection**: Transaction ID already exists
495
+ - **Resolution**: Return existing transaction result
496
+ - **Prevention**: Idempotency keys
497
+
498
+ ### Error 3: Inconsistent state
499
+ - **Cause**: Compensation partially failed
500
+ - **Detection**: State machine in invalid state
501
+ - **Resolution**: Manual intervention via admin UI
502
+ - **Prevention**: Atomic state updates, transaction logs
503
+
504
+ ## Verification
505
+ - [ ] Successful transaction commits all services
506
+ - [ ] Failed transaction compensates all completed steps
507
+ - [ ] Duplicate requests are idempotent
508
+ - [ ] Coordinator recovers from crashes
509
+ - [ ] Timeouts trigger compensation
510
+ - [ ] Circuit breakers prevent cascading failures
511
+ - [ ] All transactions logged completely
512
+ - [ ] Monitoring shows all transaction states
513
+ - [ ] Alerts fire for failures
514
+
515
+ ## Success Metrics
516
+ - **Transaction Success Rate**: > 99.9%
517
+ - **Compensation Success Rate**: > 99.5%
518
+ - **Transaction Latency**: < 2 seconds (p95)
519
+ - **Recovery Time**: < 30 seconds after coordinator crash
520
+ - **Data Consistency**: 100% (no orphaned transactions)
521
+
522
+ ## Testing
523
+ ### Unit Tests
524
+ - State machine transitions correctly
525
+ - Compensation logic executes in reverse order
526
+ - Idempotency prevents duplicate execution
527
+ - Timeout handling works correctly
528
+ - Retry logic with exponential backoff
529
+
530
+ ### Integration Tests
531
+ - End-to-end successful transaction
532
+ - End-to-end failed transaction with compensation
533
+ - Coordinator crash recovery
534
+ - Service timeout handling
535
+ - Network partition handling
536
+ - Duplicate request handling
537
+
538
+ ### Chaos Tests
539
+ - Random service failures
540
+ - Network delays and partitions
541
+ - Coordinator crashes at various points
542
+ - Database failures
543
+ - Message queue failures
544
+
545
+ ## Documentation
546
+ - [ ] Saga pattern architecture documented
547
+ - [ ] State machine diagram created
548
+ - [ ] API documentation for coordinator
549
+ - [ ] Runbook for common failures
550
+ - [ ] Admin UI user guide
551
+ - [ ] Monitoring dashboard guide
552
+
553
+ ## Rollback Plan
554
+ 1. Disable new transaction creation via feature flag
555
+ 2. Allow in-flight transactions to complete
556
+ 3. Monitor for orphaned transactions
557
+ 4. Manually resolve any inconsistencies
558
+ 5. Revert to previous transaction mechanism
559
+ 6. Investigate and fix issues
560
+ 7. Re-enable when ready
561
+
562
+ ## Estimated Effort
563
+ - **Time**: 40-60 hours (2-3 weeks)
564
+ - **Complexity**: High
565
+ - **Risk**: High (distributed systems complexity)
566
+
567
+ ## Resources
568
+ - [Saga pattern documentation](https://microservices.io/patterns/data/saga.html)
569
+ - [Distributed transactions guide](https://example.com/distributed-tx)
570
+ - [OpenTelemetry tracing](https://opentelemetry.io/)
571
+ - [Circuit breaker pattern](https://example.com/circuit-breaker)
572
+ - [Transaction coordinator design doc](https://example.com/design-doc)
573
+ ```
574
+
575
+ ## 6. Anti-Patterns (What NOT to Do)
576
+
577
+ ### 6.1 Vague Descriptions
578
+
579
+ ❌ **BAD**: "Fix the bug"
580
+ ✅ **GOOD**: "Fix null pointer exception in user profile page when user has no avatar"
581
+
582
+ ### 6.2 Missing Context
583
+
584
+ ❌ **BAD**: "Update the API"
585
+ ✅ **GOOD**: "Update user API to include profile picture URL in response payload"
586
+
587
+ ### 6.3 No Verification
588
+
589
+ ❌ **BAD**: Steps listed, no verification
590
+ ✅ **GOOD**: Clear, testable verification criteria for each requirement
591
+
592
+ ### 6.4 Unclear Dependencies
593
+
594
+ ❌ **BAD**: "Depends on other stuff"
595
+ ✅ **GOOD**: "Blocks: bd-auth (user authentication must be complete before profile features)"
596
+
597
+ ### 6.5 No Error Handling
598
+
599
+ ❌ **BAD**: Happy path only
600
+ ✅ **GOOD**: Document known failure modes and how to handle them
601
+
602
+ ## Summary
603
+
604
+ Task generation is NOT about creating quick skeletons. It's about creating comprehensive, actionable, and complete task descriptions that enable efficient execution without additional research or clarification.
605
+
606
+ **Remember**: Time spent creating a detailed task saves 10x the time during execution.
607
+