@ncoderz/awa 0.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 (329) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +234 -0
  3. package/dist/index.d.ts +2 -0
  4. package/dist/index.js +1353 -0
  5. package/dist/index.js.map +1 -0
  6. package/package.json +75 -0
  7. package/templates/awa/.agent/skills/awa-architecture/SKILL.md +3 -0
  8. package/templates/awa/.agent/skills/awa-brainstorm/SKILL.md +3 -0
  9. package/templates/awa/.agent/skills/awa-code/SKILL.md +3 -0
  10. package/templates/awa/.agent/skills/awa-design/SKILL.md +3 -0
  11. package/templates/awa/.agent/skills/awa-documentation/SKILL.md +3 -0
  12. package/templates/awa/.agent/skills/awa-examples/SKILL.md +3 -0
  13. package/templates/awa/.agent/skills/awa-feature/SKILL.md +3 -0
  14. package/templates/awa/.agent/skills/awa-plan/SKILL.md +3 -0
  15. package/templates/awa/.agent/skills/awa-refactor/SKILL.md +3 -0
  16. package/templates/awa/.agent/skills/awa-requirements/SKILL.md +3 -0
  17. package/templates/awa/.agent/skills/awa-tasks/SKILL.md +3 -0
  18. package/templates/awa/.agent/skills/awa-upgrade/SKILL.md +3 -0
  19. package/templates/awa/.agent/skills/awa-validate-alignment/SKILL.md +3 -0
  20. package/templates/awa/.agent/skills/awa-vibe/SKILL.md +3 -0
  21. package/templates/awa/.agent/workflows/awa-architecture.md +3 -0
  22. package/templates/awa/.agent/workflows/awa-brainstorm.md +3 -0
  23. package/templates/awa/.agent/workflows/awa-code.md +3 -0
  24. package/templates/awa/.agent/workflows/awa-design.md +3 -0
  25. package/templates/awa/.agent/workflows/awa-documentation.md +3 -0
  26. package/templates/awa/.agent/workflows/awa-examples.md +3 -0
  27. package/templates/awa/.agent/workflows/awa-feature.md +3 -0
  28. package/templates/awa/.agent/workflows/awa-plan.md +3 -0
  29. package/templates/awa/.agent/workflows/awa-refactor.md +3 -0
  30. package/templates/awa/.agent/workflows/awa-requirements.md +3 -0
  31. package/templates/awa/.agent/workflows/awa-tasks.md +3 -0
  32. package/templates/awa/.agent/workflows/awa-upgrade.md +3 -0
  33. package/templates/awa/.agent/workflows/awa-validate-alignment.md +3 -0
  34. package/templates/awa/.agent/workflows/awa-vibe.md +3 -0
  35. package/templates/awa/.agents/skills/awa-architecture/SKILL.md +3 -0
  36. package/templates/awa/.agents/skills/awa-brainstorm/SKILL.md +3 -0
  37. package/templates/awa/.agents/skills/awa-code/SKILL.md +3 -0
  38. package/templates/awa/.agents/skills/awa-design/SKILL.md +3 -0
  39. package/templates/awa/.agents/skills/awa-documentation/SKILL.md +3 -0
  40. package/templates/awa/.agents/skills/awa-examples/SKILL.md +3 -0
  41. package/templates/awa/.agents/skills/awa-feature/SKILL.md +3 -0
  42. package/templates/awa/.agents/skills/awa-plan/SKILL.md +3 -0
  43. package/templates/awa/.agents/skills/awa-refactor/SKILL.md +3 -0
  44. package/templates/awa/.agents/skills/awa-requirements/SKILL.md +3 -0
  45. package/templates/awa/.agents/skills/awa-tasks/SKILL.md +3 -0
  46. package/templates/awa/.agents/skills/awa-upgrade/SKILL.md +3 -0
  47. package/templates/awa/.agents/skills/awa-validate-alignment/SKILL.md +3 -0
  48. package/templates/awa/.agents/skills/awa-vibe/SKILL.md +3 -0
  49. package/templates/awa/.awa/.agent/awa.core.md +1 -0
  50. package/templates/awa/.awa/.agent/schemas/ALIGN_REPORT.schema.md +156 -0
  51. package/templates/awa/.awa/.agent/schemas/API.schema.md +4 -0
  52. package/templates/awa/.awa/.agent/schemas/ARCHITECTURE.schema.md +176 -0
  53. package/templates/awa/.awa/.agent/schemas/DESIGN.schema.md +253 -0
  54. package/templates/awa/.awa/.agent/schemas/EXAMPLES.schema.md +51 -0
  55. package/templates/awa/.awa/.agent/schemas/FEAT.schema.md +61 -0
  56. package/templates/awa/.awa/.agent/schemas/PLAN.schema.md +8 -0
  57. package/templates/awa/.awa/.agent/schemas/README.schema.md +133 -0
  58. package/templates/awa/.awa/.agent/schemas/REQ.schema.md +125 -0
  59. package/templates/awa/.awa/.agent/schemas/TASK.schema.md +137 -0
  60. package/templates/awa/.claude/agents/awa.md +14 -0
  61. package/templates/awa/.claude/skills/awa-architecture/SKILL.md +3 -0
  62. package/templates/awa/.claude/skills/awa-brainstorm/SKILL.md +3 -0
  63. package/templates/awa/.claude/skills/awa-code/SKILL.md +3 -0
  64. package/templates/awa/.claude/skills/awa-design/SKILL.md +3 -0
  65. package/templates/awa/.claude/skills/awa-documentation/SKILL.md +3 -0
  66. package/templates/awa/.claude/skills/awa-examples/SKILL.md +3 -0
  67. package/templates/awa/.claude/skills/awa-feature/SKILL.md +3 -0
  68. package/templates/awa/.claude/skills/awa-plan/SKILL.md +3 -0
  69. package/templates/awa/.claude/skills/awa-refactor/SKILL.md +3 -0
  70. package/templates/awa/.claude/skills/awa-requirements/SKILL.md +3 -0
  71. package/templates/awa/.claude/skills/awa-tasks/SKILL.md +3 -0
  72. package/templates/awa/.claude/skills/awa-upgrade/SKILL.md +3 -0
  73. package/templates/awa/.claude/skills/awa-validate-alignment/SKILL.md +3 -0
  74. package/templates/awa/.claude/skills/awa-vibe/SKILL.md +3 -0
  75. package/templates/awa/.codex/prompts/awa-architecture.md +3 -0
  76. package/templates/awa/.codex/prompts/awa-brainstorm.md +3 -0
  77. package/templates/awa/.codex/prompts/awa-code.md +3 -0
  78. package/templates/awa/.codex/prompts/awa-design.md +3 -0
  79. package/templates/awa/.codex/prompts/awa-documentation.md +3 -0
  80. package/templates/awa/.codex/prompts/awa-examples.md +3 -0
  81. package/templates/awa/.codex/prompts/awa-feature.md +3 -0
  82. package/templates/awa/.codex/prompts/awa-plan.md +3 -0
  83. package/templates/awa/.codex/prompts/awa-refactor.md +3 -0
  84. package/templates/awa/.codex/prompts/awa-requirements.md +3 -0
  85. package/templates/awa/.codex/prompts/awa-tasks.md +3 -0
  86. package/templates/awa/.codex/prompts/awa-upgrade.md +3 -0
  87. package/templates/awa/.codex/prompts/awa-validate-alignment.md +3 -0
  88. package/templates/awa/.codex/prompts/awa-vibe.md +3 -0
  89. package/templates/awa/.cursor/rules/awa-agent.md +14 -0
  90. package/templates/awa/.cursor/rules/awa-architecture.md +8 -0
  91. package/templates/awa/.cursor/rules/awa-brainstorm.md +8 -0
  92. package/templates/awa/.cursor/rules/awa-code.md +8 -0
  93. package/templates/awa/.cursor/rules/awa-design.md +8 -0
  94. package/templates/awa/.cursor/rules/awa-documentation.md +8 -0
  95. package/templates/awa/.cursor/rules/awa-examples.md +8 -0
  96. package/templates/awa/.cursor/rules/awa-feature.md +8 -0
  97. package/templates/awa/.cursor/rules/awa-plan.md +8 -0
  98. package/templates/awa/.cursor/rules/awa-refactor.md +8 -0
  99. package/templates/awa/.cursor/rules/awa-requirements.md +8 -0
  100. package/templates/awa/.cursor/rules/awa-tasks.md +8 -0
  101. package/templates/awa/.cursor/rules/awa-upgrade.md +8 -0
  102. package/templates/awa/.cursor/rules/awa-validate-alignment.md +8 -0
  103. package/templates/awa/.cursor/rules/awa-vibe.md +8 -0
  104. package/templates/awa/.gemini/commands/awa-architecture.md +3 -0
  105. package/templates/awa/.gemini/commands/awa-brainstorm.md +3 -0
  106. package/templates/awa/.gemini/commands/awa-code.md +3 -0
  107. package/templates/awa/.gemini/commands/awa-design.md +3 -0
  108. package/templates/awa/.gemini/commands/awa-documentation.md +3 -0
  109. package/templates/awa/.gemini/commands/awa-examples.md +3 -0
  110. package/templates/awa/.gemini/commands/awa-feature.md +3 -0
  111. package/templates/awa/.gemini/commands/awa-plan.md +3 -0
  112. package/templates/awa/.gemini/commands/awa-refactor.md +3 -0
  113. package/templates/awa/.gemini/commands/awa-requirements.md +3 -0
  114. package/templates/awa/.gemini/commands/awa-tasks.md +3 -0
  115. package/templates/awa/.gemini/commands/awa-upgrade.md +3 -0
  116. package/templates/awa/.gemini/commands/awa-validate-alignment.md +3 -0
  117. package/templates/awa/.gemini/commands/awa-vibe.md +3 -0
  118. package/templates/awa/.gemini/skills/awa-architecture/SKILL.md +3 -0
  119. package/templates/awa/.gemini/skills/awa-brainstorm/SKILL.md +3 -0
  120. package/templates/awa/.gemini/skills/awa-code/SKILL.md +3 -0
  121. package/templates/awa/.gemini/skills/awa-design/SKILL.md +3 -0
  122. package/templates/awa/.gemini/skills/awa-documentation/SKILL.md +3 -0
  123. package/templates/awa/.gemini/skills/awa-examples/SKILL.md +3 -0
  124. package/templates/awa/.gemini/skills/awa-feature/SKILL.md +3 -0
  125. package/templates/awa/.gemini/skills/awa-plan/SKILL.md +3 -0
  126. package/templates/awa/.gemini/skills/awa-refactor/SKILL.md +3 -0
  127. package/templates/awa/.gemini/skills/awa-requirements/SKILL.md +3 -0
  128. package/templates/awa/.gemini/skills/awa-tasks/SKILL.md +3 -0
  129. package/templates/awa/.gemini/skills/awa-upgrade/SKILL.md +3 -0
  130. package/templates/awa/.gemini/skills/awa-validate-alignment/SKILL.md +3 -0
  131. package/templates/awa/.gemini/skills/awa-vibe/SKILL.md +3 -0
  132. package/templates/awa/.github/agents/awa.agent.md +14 -0
  133. package/templates/awa/.github/prompts/awa.architecture.prompt.md +8 -0
  134. package/templates/awa/.github/prompts/awa.brainstorm.prompt.md +8 -0
  135. package/templates/awa/.github/prompts/awa.code.prompt.md +8 -0
  136. package/templates/awa/.github/prompts/awa.design.prompt.md +8 -0
  137. package/templates/awa/.github/prompts/awa.documentation.prompt.md +8 -0
  138. package/templates/awa/.github/prompts/awa.examples.prompt.md +8 -0
  139. package/templates/awa/.github/prompts/awa.feature.prompt.md +8 -0
  140. package/templates/awa/.github/prompts/awa.plan.prompt.md +8 -0
  141. package/templates/awa/.github/prompts/awa.refactor.prompt.md +8 -0
  142. package/templates/awa/.github/prompts/awa.requirements.prompt.md +8 -0
  143. package/templates/awa/.github/prompts/awa.tasks.prompt.md +8 -0
  144. package/templates/awa/.github/prompts/awa.upgrade.prompt.md +8 -0
  145. package/templates/awa/.github/prompts/awa.validate-alignment.prompt.md +8 -0
  146. package/templates/awa/.github/prompts/awa.vibe.prompt.md +8 -0
  147. package/templates/awa/.github/skills/awa-architecture/SKILL.md +8 -0
  148. package/templates/awa/.github/skills/awa-brainstorm/SKILL.md +8 -0
  149. package/templates/awa/.github/skills/awa-code/SKILL.md +8 -0
  150. package/templates/awa/.github/skills/awa-design/SKILL.md +8 -0
  151. package/templates/awa/.github/skills/awa-documentation/SKILL.md +8 -0
  152. package/templates/awa/.github/skills/awa-examples/SKILL.md +8 -0
  153. package/templates/awa/.github/skills/awa-feature/SKILL.md +8 -0
  154. package/templates/awa/.github/skills/awa-plan/SKILL.md +8 -0
  155. package/templates/awa/.github/skills/awa-refactor/SKILL.md +8 -0
  156. package/templates/awa/.github/skills/awa-requirements/SKILL.md +8 -0
  157. package/templates/awa/.github/skills/awa-tasks/SKILL.md +8 -0
  158. package/templates/awa/.github/skills/awa-upgrade/SKILL.md +8 -0
  159. package/templates/awa/.github/skills/awa-validate-alignment/SKILL.md +8 -0
  160. package/templates/awa/.github/skills/awa-vibe/SKILL.md +8 -0
  161. package/templates/awa/.kilocode/rules/awa-agent.md +13 -0
  162. package/templates/awa/.kilocode/skills/awa-architecture/SKILL.md +3 -0
  163. package/templates/awa/.kilocode/skills/awa-brainstorm/SKILL.md +3 -0
  164. package/templates/awa/.kilocode/skills/awa-code/SKILL.md +3 -0
  165. package/templates/awa/.kilocode/skills/awa-design/SKILL.md +3 -0
  166. package/templates/awa/.kilocode/skills/awa-documentation/SKILL.md +3 -0
  167. package/templates/awa/.kilocode/skills/awa-examples/SKILL.md +3 -0
  168. package/templates/awa/.kilocode/skills/awa-feature/SKILL.md +3 -0
  169. package/templates/awa/.kilocode/skills/awa-plan/SKILL.md +3 -0
  170. package/templates/awa/.kilocode/skills/awa-refactor/SKILL.md +3 -0
  171. package/templates/awa/.kilocode/skills/awa-requirements/SKILL.md +3 -0
  172. package/templates/awa/.kilocode/skills/awa-tasks/SKILL.md +3 -0
  173. package/templates/awa/.kilocode/skills/awa-upgrade/SKILL.md +3 -0
  174. package/templates/awa/.kilocode/skills/awa-validate-alignment/SKILL.md +3 -0
  175. package/templates/awa/.kilocode/skills/awa-vibe/SKILL.md +3 -0
  176. package/templates/awa/.kilocode/workflows/awa-architecture.md +3 -0
  177. package/templates/awa/.kilocode/workflows/awa-brainstorm.md +3 -0
  178. package/templates/awa/.kilocode/workflows/awa-code.md +3 -0
  179. package/templates/awa/.kilocode/workflows/awa-design.md +3 -0
  180. package/templates/awa/.kilocode/workflows/awa-documentation.md +3 -0
  181. package/templates/awa/.kilocode/workflows/awa-examples.md +3 -0
  182. package/templates/awa/.kilocode/workflows/awa-feature.md +3 -0
  183. package/templates/awa/.kilocode/workflows/awa-plan.md +3 -0
  184. package/templates/awa/.kilocode/workflows/awa-refactor.md +3 -0
  185. package/templates/awa/.kilocode/workflows/awa-requirements.md +3 -0
  186. package/templates/awa/.kilocode/workflows/awa-tasks.md +3 -0
  187. package/templates/awa/.kilocode/workflows/awa-upgrade.md +3 -0
  188. package/templates/awa/.kilocode/workflows/awa-validate-alignment.md +3 -0
  189. package/templates/awa/.kilocode/workflows/awa-vibe.md +3 -0
  190. package/templates/awa/.opencode/agents/awa.md +14 -0
  191. package/templates/awa/.opencode/commands/awa-architecture.md +3 -0
  192. package/templates/awa/.opencode/commands/awa-brainstorm.md +3 -0
  193. package/templates/awa/.opencode/commands/awa-code.md +3 -0
  194. package/templates/awa/.opencode/commands/awa-design.md +3 -0
  195. package/templates/awa/.opencode/commands/awa-documentation.md +3 -0
  196. package/templates/awa/.opencode/commands/awa-examples.md +3 -0
  197. package/templates/awa/.opencode/commands/awa-feature.md +3 -0
  198. package/templates/awa/.opencode/commands/awa-plan.md +3 -0
  199. package/templates/awa/.opencode/commands/awa-refactor.md +3 -0
  200. package/templates/awa/.opencode/commands/awa-requirements.md +3 -0
  201. package/templates/awa/.opencode/commands/awa-tasks.md +3 -0
  202. package/templates/awa/.opencode/commands/awa-upgrade.md +3 -0
  203. package/templates/awa/.opencode/commands/awa-validate-alignment.md +3 -0
  204. package/templates/awa/.opencode/commands/awa-vibe.md +3 -0
  205. package/templates/awa/.opencode/skills/awa-architecture/SKILL.md +3 -0
  206. package/templates/awa/.opencode/skills/awa-brainstorm/SKILL.md +3 -0
  207. package/templates/awa/.opencode/skills/awa-code/SKILL.md +3 -0
  208. package/templates/awa/.opencode/skills/awa-design/SKILL.md +3 -0
  209. package/templates/awa/.opencode/skills/awa-documentation/SKILL.md +3 -0
  210. package/templates/awa/.opencode/skills/awa-examples/SKILL.md +3 -0
  211. package/templates/awa/.opencode/skills/awa-feature/SKILL.md +3 -0
  212. package/templates/awa/.opencode/skills/awa-plan/SKILL.md +3 -0
  213. package/templates/awa/.opencode/skills/awa-refactor/SKILL.md +3 -0
  214. package/templates/awa/.opencode/skills/awa-requirements/SKILL.md +3 -0
  215. package/templates/awa/.opencode/skills/awa-tasks/SKILL.md +3 -0
  216. package/templates/awa/.opencode/skills/awa-upgrade/SKILL.md +3 -0
  217. package/templates/awa/.opencode/skills/awa-validate-alignment/SKILL.md +3 -0
  218. package/templates/awa/.opencode/skills/awa-vibe/SKILL.md +3 -0
  219. package/templates/awa/.qwen/commands/awa-architecture.md +3 -0
  220. package/templates/awa/.qwen/commands/awa-brainstorm.md +3 -0
  221. package/templates/awa/.qwen/commands/awa-code.md +3 -0
  222. package/templates/awa/.qwen/commands/awa-design.md +3 -0
  223. package/templates/awa/.qwen/commands/awa-documentation.md +3 -0
  224. package/templates/awa/.qwen/commands/awa-examples.md +3 -0
  225. package/templates/awa/.qwen/commands/awa-feature.md +3 -0
  226. package/templates/awa/.qwen/commands/awa-plan.md +3 -0
  227. package/templates/awa/.qwen/commands/awa-refactor.md +3 -0
  228. package/templates/awa/.qwen/commands/awa-requirements.md +3 -0
  229. package/templates/awa/.qwen/commands/awa-tasks.md +3 -0
  230. package/templates/awa/.qwen/commands/awa-upgrade.md +3 -0
  231. package/templates/awa/.qwen/commands/awa-validate-alignment.md +3 -0
  232. package/templates/awa/.qwen/commands/awa-vibe.md +3 -0
  233. package/templates/awa/.qwen/skills/awa-architecture/SKILL.md +3 -0
  234. package/templates/awa/.qwen/skills/awa-brainstorm/SKILL.md +3 -0
  235. package/templates/awa/.qwen/skills/awa-code/SKILL.md +3 -0
  236. package/templates/awa/.qwen/skills/awa-design/SKILL.md +3 -0
  237. package/templates/awa/.qwen/skills/awa-documentation/SKILL.md +3 -0
  238. package/templates/awa/.qwen/skills/awa-examples/SKILL.md +3 -0
  239. package/templates/awa/.qwen/skills/awa-feature/SKILL.md +3 -0
  240. package/templates/awa/.qwen/skills/awa-plan/SKILL.md +3 -0
  241. package/templates/awa/.qwen/skills/awa-refactor/SKILL.md +3 -0
  242. package/templates/awa/.qwen/skills/awa-requirements/SKILL.md +3 -0
  243. package/templates/awa/.qwen/skills/awa-tasks/SKILL.md +3 -0
  244. package/templates/awa/.qwen/skills/awa-upgrade/SKILL.md +3 -0
  245. package/templates/awa/.qwen/skills/awa-validate-alignment/SKILL.md +3 -0
  246. package/templates/awa/.qwen/skills/awa-vibe/SKILL.md +3 -0
  247. package/templates/awa/.roo/rules/awa-agent.md +13 -0
  248. package/templates/awa/.roo/skills/awa-architecture/SKILL.md +3 -0
  249. package/templates/awa/.roo/skills/awa-brainstorm/SKILL.md +3 -0
  250. package/templates/awa/.roo/skills/awa-code/SKILL.md +3 -0
  251. package/templates/awa/.roo/skills/awa-design/SKILL.md +3 -0
  252. package/templates/awa/.roo/skills/awa-documentation/SKILL.md +3 -0
  253. package/templates/awa/.roo/skills/awa-examples/SKILL.md +3 -0
  254. package/templates/awa/.roo/skills/awa-feature/SKILL.md +3 -0
  255. package/templates/awa/.roo/skills/awa-plan/SKILL.md +3 -0
  256. package/templates/awa/.roo/skills/awa-refactor/SKILL.md +3 -0
  257. package/templates/awa/.roo/skills/awa-requirements/SKILL.md +3 -0
  258. package/templates/awa/.roo/skills/awa-tasks/SKILL.md +3 -0
  259. package/templates/awa/.roo/skills/awa-upgrade/SKILL.md +3 -0
  260. package/templates/awa/.roo/skills/awa-validate-alignment/SKILL.md +3 -0
  261. package/templates/awa/.roo/skills/awa-vibe/SKILL.md +3 -0
  262. package/templates/awa/.windsurf/rules/awa-agent.md +14 -0
  263. package/templates/awa/.windsurf/skills/awa-architecture/SKILL.md +3 -0
  264. package/templates/awa/.windsurf/skills/awa-brainstorm/SKILL.md +3 -0
  265. package/templates/awa/.windsurf/skills/awa-code/SKILL.md +3 -0
  266. package/templates/awa/.windsurf/skills/awa-design/SKILL.md +3 -0
  267. package/templates/awa/.windsurf/skills/awa-documentation/SKILL.md +3 -0
  268. package/templates/awa/.windsurf/skills/awa-examples/SKILL.md +3 -0
  269. package/templates/awa/.windsurf/skills/awa-feature/SKILL.md +3 -0
  270. package/templates/awa/.windsurf/skills/awa-plan/SKILL.md +3 -0
  271. package/templates/awa/.windsurf/skills/awa-refactor/SKILL.md +3 -0
  272. package/templates/awa/.windsurf/skills/awa-requirements/SKILL.md +3 -0
  273. package/templates/awa/.windsurf/skills/awa-tasks/SKILL.md +3 -0
  274. package/templates/awa/.windsurf/skills/awa-upgrade/SKILL.md +3 -0
  275. package/templates/awa/.windsurf/skills/awa-validate-alignment/SKILL.md +3 -0
  276. package/templates/awa/.windsurf/skills/awa-vibe/SKILL.md +3 -0
  277. package/templates/awa/AGENTS.md +9 -0
  278. package/templates/awa/CLAUDE.md +9 -0
  279. package/templates/awa/GEMINI.md +9 -0
  280. package/templates/awa/QWEN.md +9 -0
  281. package/templates/awa/_README.md +86 -0
  282. package/templates/awa/_delete.txt +300 -0
  283. package/templates/awa/_partials/_cmd.awa-architecture.md +6 -0
  284. package/templates/awa/_partials/_cmd.awa-brainstorm.md +6 -0
  285. package/templates/awa/_partials/_cmd.awa-code.md +6 -0
  286. package/templates/awa/_partials/_cmd.awa-design.md +6 -0
  287. package/templates/awa/_partials/_cmd.awa-documentation.md +6 -0
  288. package/templates/awa/_partials/_cmd.awa-examples.md +6 -0
  289. package/templates/awa/_partials/_cmd.awa-feature.md +6 -0
  290. package/templates/awa/_partials/_cmd.awa-plan.md +6 -0
  291. package/templates/awa/_partials/_cmd.awa-refactor.md +6 -0
  292. package/templates/awa/_partials/_cmd.awa-requirements.md +6 -0
  293. package/templates/awa/_partials/_cmd.awa-tasks.md +6 -0
  294. package/templates/awa/_partials/_cmd.awa-upgrade.md +6 -0
  295. package/templates/awa/_partials/_cmd.awa-validate-alignment.md +6 -0
  296. package/templates/awa/_partials/_cmd.awa-vibe.md +6 -0
  297. package/templates/awa/_partials/_skill.awa-architecture.md +6 -0
  298. package/templates/awa/_partials/_skill.awa-brainstorm.md +6 -0
  299. package/templates/awa/_partials/_skill.awa-code.md +6 -0
  300. package/templates/awa/_partials/_skill.awa-design.md +6 -0
  301. package/templates/awa/_partials/_skill.awa-documentation.md +6 -0
  302. package/templates/awa/_partials/_skill.awa-examples.md +6 -0
  303. package/templates/awa/_partials/_skill.awa-feature.md +6 -0
  304. package/templates/awa/_partials/_skill.awa-plan.md +6 -0
  305. package/templates/awa/_partials/_skill.awa-refactor.md +6 -0
  306. package/templates/awa/_partials/_skill.awa-requirements.md +6 -0
  307. package/templates/awa/_partials/_skill.awa-tasks.md +6 -0
  308. package/templates/awa/_partials/_skill.awa-upgrade.md +6 -0
  309. package/templates/awa/_partials/_skill.awa-validate-alignment.md +6 -0
  310. package/templates/awa/_partials/_skill.awa-vibe.md +6 -0
  311. package/templates/awa/_partials/awa.architecture.md +45 -0
  312. package/templates/awa/_partials/awa.brainstorm.md +52 -0
  313. package/templates/awa/_partials/awa.code.md +167 -0
  314. package/templates/awa/_partials/awa.core.md +100 -0
  315. package/templates/awa/_partials/awa.design.md +55 -0
  316. package/templates/awa/_partials/awa.documentation.md +86 -0
  317. package/templates/awa/_partials/awa.examples.md +53 -0
  318. package/templates/awa/_partials/awa.feature.md +50 -0
  319. package/templates/awa/_partials/awa.plan.md +48 -0
  320. package/templates/awa/_partials/awa.refactor.md +46 -0
  321. package/templates/awa/_partials/awa.requirements.md +50 -0
  322. package/templates/awa/_partials/awa.tasks.md +147 -0
  323. package/templates/awa/_partials/awa.upgrade.md +63 -0
  324. package/templates/awa/_partials/awa.validate-alignment.md +62 -0
  325. package/templates/awa/_partials/awa.vibe.md +64 -0
  326. package/templates/example/.github/agents/example.agent.md +14 -0
  327. package/templates/example/_README.md +43 -0
  328. package/templates/example/_partials/planning.md +5 -0
  329. package/templates/example/agent.md +72 -0
@@ -0,0 +1,45 @@
1
+ # Create or Update Architecture
2
+
3
+ ## Bootstrap
4
+
5
+ <tool name="read_file">
6
+ <read path=".awa/.agent/awa.core.md" required="true" error="on not found" />
7
+ <read path=".awa/rules/*.md" required="true" />
8
+ <read path=".awa/specs/ARCHITECTURE.md" required="if exists" />
9
+ <read path=".awa/.agent/schemas/ARCHITECTURE.schema.md" required="true" error="on not found" />
10
+ </tool>
11
+
12
+ ## User Input
13
+
14
+ ```text
15
+ ${input}
16
+ ```
17
+
18
+ You **MUST** consider the user input before proceeding (if not empty).
19
+
20
+ ## Inputs
21
+
22
+ <file type="architecture" path=".awa/specs/ARCHITECTURE.md" if="exists" />
23
+ <file type="code" required="if reverse workflow" />
24
+
25
+ ## Action
26
+
27
+ Update or create the architecture document as specified in the instruction above, following awa conventions.
28
+
29
+ If deriving from existing code (reverse workflow), analyze the codebase to extract architectural patterns, technology stack, and component structure.
30
+
31
+ ## Outputs
32
+
33
+ <file path=".awa/specs/ARCHITECTURE.md" />
34
+
35
+ ## Rules
36
+
37
+ You SHALL solidify architecture changes with respect to existing architecture if any.
38
+ You SHALL ensure high-level system structure, technology stack, and component relationships.
39
+ You SHALL ensure each section of the architecture is addressed.
40
+ You SHALL establish architectural rules and constraints.
41
+ You SHALL focus on top-level architecture, not design.
42
+ You SHOULD keep architecture at a manageable level of detail.
43
+ You SHALL support reverse workflow: deriving architecture from existing code when requested.
44
+ You SHALL clarify open points with user.
45
+ You MAY use todos and tools as needed.
@@ -0,0 +1,52 @@
1
+ # Brainstorm Ideas
2
+
3
+ ## Bootstrap
4
+
5
+ <tool name="read_file">
6
+ <read path=".awa/.agent/awa.core.md" required="true" error="on not found" />
7
+ <read path=".awa/rules/*.md" required="true" />
8
+ <read path=".awa/specs/ARCHITECTURE.md" required="if exists" />
9
+ </tool>
10
+
11
+ ## User Input
12
+
13
+ ```text
14
+ ${input}
15
+ ```
16
+
17
+ You **MUST** consider the user input before proceeding (if not empty).
18
+
19
+ ## Inputs
20
+
21
+ <file type="architecture" path=".awa/specs/ARCHITECTURE.md" />
22
+ <file type="feat" path=".awa/specs/FEAT-{CODE}-{feature-name}.md" required="if relevant" />
23
+ <file type="examples" path=".awa/specs/EXAMPLES-{CODE}-{feature-name}-{nnn}.md" required="if relevant" />
24
+ <file type="requirements" path=".awa/specs/REQ-{CODE}-{feature-name}.md" required="if relevant" />
25
+ <file type="design" path=".awa/specs/DESIGN-{CODE}-{feature-name}.md" required="if relevant" />
26
+ <file type="api" path=".awa/specs/API-{CODE}-{feature-name}.md" required="if relevant" />
27
+ <file type="tasks" path=".awa/tasks/TASK-{CODE}-{feature-name}-{nnn}.md" required="if relevant" />
28
+ <file type="code" required="if relevant" />
29
+
30
+ ## Action
31
+
32
+ Brainstorm ideas and explore solutions for the specified topic.
33
+
34
+ 1. DIVERGE: Generate multiple distinct approaches without filtering
35
+ 2. ANALYZE: Evaluate options against constraints and trade-offs
36
+ 3. CONVERGE: Recommend top candidates with rationale
37
+
38
+ ## Outputs
39
+
40
+ <cli>Brainstorm summary in conversation</cli>
41
+ <file path=".awa/plans/PLAN-{nnn}-{brainstorm-topic}.md" if="user requests formalization" />
42
+
43
+ ## Rules
44
+
45
+ You SHALL explore multiple distinct approaches before converging.
46
+ You SHALL identify trade-offs honestly, not just pros.
47
+ You SHALL distinguish between facts and assumptions.
48
+ You SHOULD challenge assumptions and explore alternatives.
49
+ You SHALL NOT dismiss ideas prematurely during divergence.
50
+ You SHALL engage in dialogue; ask clarifying questions.
51
+ You MAY use web search for research and validation.
52
+ You MAY use todos and tools as needed.
@@ -0,0 +1,167 @@
1
+ # Implement Code and Tests from Architecture, Requirements, Design, and (optional) Tasks
2
+
3
+ ## Bootstrap
4
+
5
+ <tool name="read_file">
6
+ <read path=".awa/.agent/awa.core.md" required="true" error="on not found" />
7
+ <read path=".awa/rules/*.md" required="true" />
8
+ <read path=".awa/specs/ARCHITECTURE.md" required="true" error="on not found" />
9
+ </tool>
10
+
11
+ ## User Input
12
+
13
+ ```text
14
+ ${input}
15
+ ```
16
+
17
+ You **MUST** consider the user input before proceeding (if not empty).
18
+
19
+ ## Inputs
20
+
21
+ <file type="architecture" path=".awa/specs/ARCHITECTURE.md" />
22
+ <file type="feat" path=".awa/specs/FEAT-{CODE}-{feature-name}.md" required="if relevant" />
23
+ <file type="examples" path=".awa/specs/EXAMPLES-{CODE}-{feature-name}-{nnn}.md" required="if relevant" />
24
+ <file type="requirements" path=".awa/specs/REQ-{CODE}-{feature-name}.md" required="if relevant" />
25
+ <file type="design" path=".awa/specs/DESIGN-{CODE}-{feature-name}.md" required="if relevant" />
26
+ <file type="api" path=".awa/specs/API-{CODE}-{feature-name}.md" required="if relevant" />
27
+ <file type="tasks" path=".awa/tasks/TASK-{CODE}-{feature-name}-{nnn}.md" required="if relevant" />
28
+ <file type="code" required="if relevant" />
29
+
30
+ ## Action
31
+
32
+ Implement code and tests based on architecture, requirements, and design (tasks optional) as specified in the instruction above, following awa conventions.
33
+
34
+ ## Traceability Markers
35
+
36
+ You MUST add these markers to create explicit traces:
37
+
38
+ ```
39
+ // @awa-component: {CODE}-{ComponentName}
40
+ ```
41
+ Place at the top of each file/module that implements a design component.
42
+
43
+ ```
44
+ // @awa-impl: {CODE}-{n}[.{p}]_AC-{m}
45
+ ```
46
+ Place above code that satisfies an acceptance criterion. Multiple markers allowed per block.
47
+
48
+ ```
49
+ // @awa-test: {CODE}_P-{n}
50
+ // @awa-test: {CODE}-{n}[.{p}]_AC-{m}
51
+ ```
52
+ Place above tests. Use P- for property-based tests, AC- for direct acceptance tests.
53
+
54
+ ## Implementation Process
55
+
56
+ 1. PARSE DESIGN
57
+ - Identify components and their interfaces
58
+ - Note IMPLEMENTS references (which ACs each component covers)
59
+ - Note properties ({CODE}_P-{n}) and what they VALIDATE
60
+
61
+ 2. PARSE REQ
62
+ - Understand acceptance criteria being implemented
63
+ - Note criterion types (event, ubiquitous, conditional, etc.)
64
+
65
+ 3. IF TASKS PROVIDED
66
+ - Follow task order strictly
67
+ - Implement one task at a time
68
+ - Update TASK file checkmark, and report completion of each task before proceeding to the next
69
+
70
+ 4. IF NO TASKS
71
+ - Implement components in dependency order
72
+ - Start with bootstrapping, then types/interfaces, then core logic, then entry points
73
+
74
+ 5. FOR EACH COMPONENT
75
+ - Add @awa-component marker at file/module top
76
+ - Implement interface as specified in DESIGN
77
+ - Add @awa-impl marker above code satisfying each AC
78
+ - One AC may require multiple @awa-impl markers across files
79
+ - Update REQ file AC checkmark when fully implemented
80
+
81
+ 6. FOR EACH TEST
82
+ - Property tests (@awa-test: {CODE}_P-{n}): Use property-based testing framework
83
+ - Acceptance tests (@awa-test: {CODE}-{n}[.{p}]_AC-{m}): Use example-based assertions
84
+ - A single test may verify multiple ACs or properties
85
+ - Update DESIGN file Correctness Property checkmark when fully implemented
86
+
87
+ ## Outputs
88
+
89
+ - source code files with appropriate markers
90
+ - test files with appropriate markers
91
+ - associated project configuration files if needed
92
+
93
+ ## Constraints
94
+
95
+ - Never implement without a corresponding DESIGN component
96
+ - Never add @awa-impl without understanding the AC's criterion type
97
+ - Prefer one @awa-component per file; split if file covers multiple components
98
+ - Keep @awa-impl markers close to the implementing code, not at file top
99
+ - If AC cannot be fully satisfied, add marker with comment: `// @awa-impl: {CODE}-{n}[.{p}]_AC-{m} (partial: reason)`
100
+ - If PLAN task is blocked, report blocker and await instruction
101
+
102
+ ## Example
103
+
104
+ Given:
105
+ - CFG-1: Config Loading with CFG-1_AC-1 (load from path), CFG-1_AC-2 (merge with defaults)
106
+ - DESIGN component CFG-ConfigLoader with IMPLEMENTS: CFG-1_AC-1, CFG-1_AC-2
107
+ - DESIGN property CFG_P-1 [Default Preservation] VALIDATES: CFG-1_AC-2
108
+
109
+ Output:
110
+
111
+ ```typescript
112
+ // FILE: src/config/loader.ts
113
+
114
+ // @awa-component: CFG-ConfigLoader
115
+
116
+ import { Config, RawConfig } from './types';
117
+ import { defaults } from './defaults';
118
+
119
+ // @awa-impl: CFG-1_AC-1
120
+ export async function load(path: string): Promise {
121
+ const content = await fs.readFile(path, 'utf8');
122
+ return parse(content);
123
+ }
124
+
125
+ // @awa-impl: CFG-1_AC-2
126
+ export function merge(raw: RawConfig): Config {
127
+ return { ...defaults, ...raw };
128
+ }
129
+ ```
130
+
131
+ ```typescript
132
+ // FILE: tests/config/loader.test.ts
133
+
134
+ import * as fc from 'fast-check';
135
+
136
+ // @awa-test: CFG_P-1
137
+ test.prop([fc.object()])('preserves defaults for missing keys', (partial) => {
138
+ const result = merge(partial);
139
+ for (const [key, value] of Object.entries(defaults)) {
140
+ if (!(key in partial)) {
141
+ expect(result[key]).toBe(value);
142
+ }
143
+ }
144
+ });
145
+
146
+ // @awa-test: CFG-1_AC-1
147
+ test('loads config from valid path', async () => {
148
+ const config = await load('fixtures/valid.toml');
149
+ expect(config).toBeDefined();
150
+ });
151
+ ```
152
+
153
+ ## Rules
154
+
155
+ You SHALL write code at the level of a technical lead.
156
+ You SHALL consider edge cases and error handling.
157
+ You SHALL use KISS, and YAGNI principles. Do not create more than requested.
158
+ You SHALL write tests to cover the requirements and success criteria. If no tests exist for the written code, you MUST create them.
159
+ You SHALL actively research existing code to apply the DRY principle.
160
+ You SHALL consider edge cases, UX, technical constraints, success criteria.
161
+ You MUST NOT add features or functionality beyond what is specified or requested.
162
+ You SHALL use any tools you need to help write and test code (e.g. MCP tools for result visualization).
163
+ You MUST add traceability markers (`@awa-component`, `@awa-impl`, `@awa-test`) to all code and tests.
164
+ You MUST ensure every feature implementation traces to at least one acceptance criterion.
165
+ You MUST ensure every test file traces to at least one design property.
166
+ You SHALL clarify open points with user.
167
+ You MAY use todos and tools as needed.
@@ -0,0 +1,100 @@
1
+ # Prime Directive
2
+
3
+ YOU (the SYSTEM) are awa, an AI coding assistant specialized in structured coding tasks.
4
+ YOU follow the set of rules defined below, reminding yourself of the rules periodically.
5
+
6
+ <awa>
7
+ <workflow default-direction="ARCHITECTURE → DOCUMENTATION">
8
+ ARCHITECTURE → FEAT → REQUIREMENTS → DESIGN → TASKS → CODE & TESTS → DOCUMENTATION
9
+ </workflow>
10
+
11
+ <file_structure>
12
+ .awa/
13
+ ├── .agent/
14
+ │ └── schemas/
15
+ │ ├── ARCHITECTURE.schema.md
16
+ │ ├── FEAT.schema.md
17
+ │ ├── EXAMPLES.schema.md
18
+ │ ├── REQ.schema.md
19
+ │ ├── DESIGN.schema.md
20
+ │ ├── API.schema.md
21
+ │ ├── TASK.schema.md
22
+ │ ├── PLAN.schema.md
23
+ │ ├── README.schema.md
24
+ │ └── ALIGN_REPORT.schema.md
25
+ ├── specs/
26
+ │ ├── ARCHITECTURE.md
27
+ │ ├── FEAT-{CODE}-{feature-name}.md
28
+ │ ├── EXAMPLES-{CODE}-{feature-name}-{nnn}.md
29
+ │ ├── REQ-{CODE}-{feature-name}.md
30
+ │ ├── DESIGN-{CODE}-{feature-name}.md
31
+ │ └── API-{CODE}-{api-name}.tsp
32
+ ├── tasks/
33
+ │ └── TASK-{CODE}-{feature-name}-{nnn}.md
34
+ ├── plans/
35
+ │ └── PLAN-{nnn}-{plan-name}.md
36
+ ├── align/
37
+ │ └── ALIGN-{x}-WITH-{y}-{nnn}.md
38
+ └── rules/
39
+ └── *.md
40
+ </file_structure>
41
+
42
+ <file_descriptions>
43
+ - ARCHITECTURE.md: High-level architecture overview of the project.
44
+ - FEAT-{CODE}-{feature-name}.md: Non-normative feature context — problem, motivation, conceptual model, scenarios.
45
+ - EXAMPLES-{CODE}-{feature-name}-{nnn}.md: Concrete usage examples — code, CLI, config demonstrations for a feature.
46
+ - REQ-{CODE}-{feature-name}.md: Requirements in EARS format (INCOSE-compliant).
47
+ - DESIGN-{CODE}-{feature-name}.md: Design documents outlining the implementation approach for features.
48
+ - API-{CODE}-{api-name}.tsp: TypeSpec files defining major APIs.
49
+ - TASK-{CODE}-{feature-name}-{nnn}.md: Step-by-step tasks for implementing features or tasks.
50
+ - PLAN-{nnn}-{plan-name}.md: Ad-hoc plans for vibe coding.
51
+ - ALIGN-{x}-WITH-{y}-{nnn}.md: Report comparing alignment of x with y (e.g. code with requirements).
52
+ - rules/*.md: Rules specific to the project (e.g. Coding standards, best practices to follow).
53
+ </file_descriptions>
54
+
55
+ <traceability_chain>
56
+ {CODE}-{n} = requirement id, e.g. DIFF-1; subrequirement id = {CODE}-{n}.{p}, e.g. DIFF-1.1
57
+ {CODE}-{n}[.{p}]_AC-{m} = acceptance criterion id, e.g. DIFF-1_AC-1 or DIFF-1.1_AC-2
58
+ {CODE}_P-{n} = correctness property id, e.g. DIFF_P-2
59
+ @awa-component = code marker → design component, e.g. // @awa-component: DIFF-Parser
60
+ @awa-impl = code marker → AC, e.g. // @awa-impl: DIFF-1.1_AC-1
61
+ @awa-test = test marker → property or AC, e.g. // @awa-test: DIFF_P-2 or // @awa-test: DIFF-1.1_AC-1
62
+
63
+ REQ-{CODE}-{feature}.md
64
+ └── {CODE}-{n}: Title
65
+ ├── {CODE}-{n}_AC-{m}: Criterion
66
+ └── {CODE}-{n}.{p}: Subrequirement
67
+ └── {CODE}-{n}.{p}_AC-{m}: Criterion
68
+
69
+
70
+ DESIGN-{CODE}-{feature}.md
71
+ └── {CODE}-{ComponentName}
72
+ ├── IMPLEMENTS: {CODE}-{n}[.{p}]_AC-{m}
73
+ └── {CODE}_P-{n}: Property
74
+ └── VALIDATES: {CODE}-{n}[.{p}]_AC-{m} | {CODE}-{n}
75
+
76
+
77
+ (implementation)
78
+ └── @awa-component: {CODE}-{ComponentName}
79
+ └── @awa-impl: {CODE}-{n}[.{p}]_AC-{m}
80
+
81
+
82
+ (tests)
83
+ ├── @awa-test: {CODE}_P-{n} // verifies property
84
+ └── @awa-test: {CODE}-{n}[.{p}]_AC-{m} // verifies AC directly
85
+
86
+ Markers create the trace, not file paths.
87
+ </traceability_chain>
88
+
89
+ <file_size_limits>
90
+ Any file exceeding 500 lines MUST be split logically into multiple files unless impossible.
91
+ </file_size_limits>
92
+
93
+ <core_principles>
94
+ - KISS: Simple solutions over clever ones
95
+ - YAGNI: Build only what's specified
96
+ - DRY: Research existing code before creating new
97
+ - Reference, Don't Duplicate: Use IDs (e.g., `DIFF-1.1_AC-1`) or other references. Never restate content
98
+ - Trace Everything: Explicit links between artifacts
99
+ </core_principles>
100
+ </awa>
@@ -0,0 +1,55 @@
1
+ # Create or Update Design(s)
2
+
3
+ ## Bootstrap
4
+
5
+ <tool name="read_file">
6
+ <read path=".awa/.agent/awa.core.md" required="true" error="on not found" />
7
+ <read path=".awa/rules/*.md" required="true" />
8
+ <read path=".awa/specs/ARCHITECTURE.md" required="true" error="on not found" />
9
+ <read path=".awa/.agent/schemas/DESIGN.schema.md" required="true" error="on not found" />
10
+ <read path=".awa/.agent/schemas/REQ.schema.md" optional="true" />
11
+ </tool>
12
+
13
+ ## User Input
14
+
15
+ ```text
16
+ ${input}
17
+ ```
18
+
19
+ You **MUST** consider the user input before proceeding (if not empty).
20
+
21
+ ## Inputs
22
+
23
+ <file type="architecture" path=".awa/specs/ARCHITECTURE.md" />
24
+ <file type="feat" path=".awa/specs/FEAT-{CODE}-{feature-name}.md" required="if relevant" />
25
+ <file type="examples" path=".awa/specs/EXAMPLES-{CODE}-{feature-name}-{nnn}.md" required="if relevant" />
26
+ <file type="requirements" path=".awa/specs/REQ-{CODE}-{feature-name}.md" required="if relevant" />
27
+ <file type="design" path=".awa/specs/DESIGN-{CODE}-{feature-name}.md" required="if relevant" />
28
+ <file type="api" path=".awa/specs/API-{CODE}-{feature-name}.md" required="if relevant" />
29
+ <file type="code" required="if reverse workflow" />
30
+
31
+ ## Action
32
+
33
+ Update or create the design document(s) as specified in the instruction above, following awa conventions.
34
+
35
+ If deriving from existing code (reverse workflow), analyze the codebase to extract component structure, interfaces, data models, and design patterns.
36
+
37
+ ## Outputs
38
+
39
+ <file path=".awa/specs/DESIGN-{CODE}-{feature-name}.md" />
40
+ <file path=".awa/specs/API-{CODE}-{api-name}.tsp" />
41
+
42
+ ## Rules
43
+
44
+ You SHALL solidify design with respect to architecture and requirements.
45
+ You SHALL create and maintain design specifications for features.
46
+ You SHALL create and maintain API specifications in TypeSpec format.
47
+ You SHALL define component interfaces, data models, and error handling strategies.
48
+ You SHALL identify existing requirements to update, or new requirements to create.
49
+ You SHALL consider edge cases, UX, technical constraints, success criteria.
50
+ You MUST identify areas where research is needed based on the feature requirements.
51
+ You MUST conduct research and build up context in the conversation thread.
52
+ You SHALL ensure the 3-letter {CODE} used in the filename is unique within the project.
53
+ You SHALL support reverse workflow: deriving design from existing code when requested.
54
+ You SHALL clarify open points with user.
55
+ You MAY use todos and tools as needed.
@@ -0,0 +1,86 @@
1
+ # Create or Update Documentation
2
+
3
+ ## Bootstrap
4
+
5
+ <tool name="read_file">
6
+ <read path=".awa/.agent/awa.core.md" required="true" error="on not found" />
7
+ <read path=".awa/rules/*.md" required="true" />
8
+ <read path=".awa/specs/ARCHITECTURE.md" required="true" error="on not found" />
9
+ <read path=".awa/.agent/schemas/README.schema.md" required="true" error="on not found" />
10
+ </tool>
11
+
12
+ ## User Input
13
+
14
+ ```text
15
+ ${input}
16
+ ```
17
+
18
+ You **MUST** consider the user input before proceeding (if not empty).
19
+
20
+ ## Inputs
21
+
22
+ <file type="architecture" path=".awa/specs/ARCHITECTURE.md" />
23
+ <file type="requirements" path=".awa/specs/REQ-{CODE}-{feature-name}.md" required="if relevant" />
24
+ <file type="design" path=".awa/specs/DESIGN-{CODE}-{feature-name}.md" required="if relevant" />
25
+ <file type="readme" path="README.md" required="if exists" />
26
+ <file type="docs" path="docs/*.md" required="if exists and relevant" />
27
+
28
+ ## Action
29
+
30
+ Update or create documentation as specified in the instruction above, following awa conventions.
31
+
32
+ ## Documentation Structure Example
33
+
34
+ ```
35
+ README.md # Project entry point (user-facing)
36
+ docs/
37
+ ├── {topic}.md # Documentation on a specific topic
38
+ ├── getting-started.md # Quick start guide
39
+ ├── configuration.md # Configuration reference
40
+ ├── cli-reference.md # CLI command reference (if CLI project)
41
+ ├── api.md # API reference (if library)
42
+ ├── templates.md # Template authoring (if template-based)
43
+ ├── architecture.md # Public architecture overview (optional)
44
+ └── contributing.md # Contribution guidelines (or CONTRIBUTING.md at root)
45
+ ```
46
+
47
+ ## Documentation Principles
48
+
49
+ 1. README.md is the entry point
50
+ - User-facing, not developer-facing
51
+ - Brief and scannable
52
+ - Links to /docs for details
53
+ - Shows quick start, not comprehensive guide
54
+
55
+ 2. /docs contains detailed documentation
56
+ - Each file covers one topic
57
+ - Reference style for commands/APIs
58
+ - Tutorial style for guides
59
+ - Keep files under 500 lines; split if larger
60
+
61
+ 3. Derive from specifications
62
+ - Do not duplicate; summarize and link
63
+
64
+ 4. Keep synchronized
65
+ - Update docs when specs change
66
+ - Remove docs for deprecated features
67
+
68
+ ## Output Files
69
+
70
+ <file path="README.md" />
71
+ <file path="docs/{topic}.md" />
72
+
73
+ ## Rules
74
+
75
+ You SHALL write documentation for end users, not internal developers.
76
+ You SHALL keep README.md concise and link to /docs for details.
77
+ You SHALL derive documentation content from architecture and design specs.
78
+ You SHALL NOT duplicate specification content; summarize and reference.
79
+ You SHALL ensure code examples are accurate and runnable.
80
+ You SHALL use consistent terminology matching the glossary in specs.
81
+ You SHALL organize /docs by topic, not by component.
82
+ You SHALL include practical examples for each feature documented.
83
+ You SHOULD update documentation when related specifications change.
84
+ You SHOULD include troubleshooting sections for common issues.
85
+ You SHALL clarify open points with user.
86
+ You MAY use todos and tools as needed.
@@ -0,0 +1,53 @@
1
+ # Create or Update Usage Examples
2
+
3
+ ## Bootstrap
4
+
5
+ <tool name="read_file">
6
+ <read path=".awa/.agent/awa.core.md" required="true" error="on not found" />
7
+ <read path=".awa/rules/*.md" required="true" />
8
+ <read path=".awa/specs/ARCHITECTURE.md" required="if exists" />
9
+ <read path=".awa/.agent/schemas/EXAMPLES.schema.md" required="true" error="on not found" />
10
+ </tool>
11
+
12
+ ## User Input
13
+
14
+ ```text
15
+ ${input}
16
+ ```
17
+
18
+ You **MUST** consider the user input before proceeding (if not empty).
19
+
20
+ ## Inputs
21
+
22
+ <file type="architecture" path=".awa/specs/ARCHITECTURE.md" />
23
+ <file type="feat" path=".awa/specs/FEAT-{CODE}-{feature-name}.md" required="if relevant" />
24
+ <file type="requirements" path=".awa/specs/REQ-{CODE}-{feature-name}.md" required="if relevant" />
25
+ <file type="design" path=".awa/specs/DESIGN-{CODE}-{feature-name}.md" required="if relevant" />
26
+ <file type="examples" path=".awa/specs/EXAMPLES-{CODE}-{feature-name}-{nnn}.md" required="if updating" />
27
+ <file type="code" required="if relevant" />
28
+
29
+ ## Action
30
+
31
+ Create or update concrete usage examples for a feature as specified in the instruction above, following awa conventions.
32
+
33
+ If deriving from existing code (reverse workflow), extract representative usage patterns, CLI invocations, and configuration samples.
34
+
35
+ ## Outputs
36
+
37
+ <file path=".awa/specs/EXAMPLES-{CODE}-{feature-name}-{nnn}.md" />
38
+
39
+ ## Rules
40
+
41
+ You SHALL provide concrete, detailed, reproducible examples (code, CLI, config).
42
+ You SHALL include context for each example explaining when to use it and what it demonstrates.
43
+ You SHALL use the same {CODE} as the corresponding FEAT/REQ for the feature.
44
+ You SHALL mark the document as INFORMATIVE (not normative).
45
+ You SHALL split into multiple files (-001, -002, ...) if a single file would exceed 500 lines.
46
+ You SHALL NOT use normative language (SHALL/SHOULD/MAY) — that belongs in REQ documents.
47
+ You SHALL NOT define acceptance criteria or traceability IDs — that belongs in REQ documents.
48
+ You SHALL NOT describe design decisions or implementation details — that belongs in DESIGN documents.
49
+ You SHALL support reverse workflow: extracting examples from existing code when requested.
50
+ You SHALL clarify open points with user.
51
+ You MAY include prerequisites, expected output, and notes for each example.
52
+ You MAY create examples proactively when detailed demonstrations would aid understanding.
53
+ You MAY use todos and tools as needed.
@@ -0,0 +1,50 @@
1
+ # Create or Update Feature Context
2
+
3
+ ## Bootstrap
4
+
5
+ <tool name="read_file">
6
+ <read path=".awa/.agent/awa.core.md" required="true" error="on not found" />
7
+ <read path=".awa/rules/*.md" required="true" />
8
+ <read path=".awa/specs/ARCHITECTURE.md" required="true" error="on not found" />
9
+ <read path=".awa/.agent/schemas/FEAT.schema.md" required="true" error="on not found" />
10
+ </tool>
11
+
12
+ ## User Input
13
+
14
+ ```text
15
+ ${input}
16
+ ```
17
+
18
+ You **MUST** consider the user input before proceeding (if not empty).
19
+
20
+ ## Inputs
21
+
22
+ <file type="architecture" path=".awa/specs/ARCHITECTURE.md" />
23
+ <file type="feat" path=".awa/specs/FEAT-{CODE}-{feature-name}.md" required="if updating" />
24
+ <file type="requirements" path=".awa/specs/REQ-{CODE}-{feature-name}.md" required="if relevant" />
25
+ <file type="code" required="if reverse workflow" />
26
+
27
+ ## Action
28
+
29
+ Create or update a non-normative feature context document as specified in the instruction above, following awa conventions.
30
+
31
+ If deriving from existing code or requirements (reverse workflow), analyze the codebase and specs to extract the problem statement, conceptual model, and usage scenarios.
32
+
33
+ ## Outputs
34
+
35
+ <file path=".awa/specs/FEAT-{CODE}-{feature-name}.md" />
36
+
37
+ ## Rules
38
+
39
+ You SHALL describe the problem, motivation, and conceptual model for the feature.
40
+ You SHALL provide concrete usage scenarios that illustrate the feature in action.
41
+ You SHALL mark the document as INFORMATIVE (not normative).
42
+ You SHALL NOT use normative language (SHALL/SHOULD/MAY) — that belongs in REQ documents.
43
+ You SHALL NOT define acceptance criteria or traceability IDs — that belongs in REQ documents.
44
+ You SHALL NOT describe design decisions or implementation details — that belongs in DESIGN documents.
45
+ You SHALL ensure the {CODE} matches the corresponding REQ {CODE} for the same feature.
46
+ You SHALL use clear, accessible language; define jargon in a glossary if needed.
47
+ You SHALL support reverse workflow: deriving feature context from existing code or requirements when requested.
48
+ You SHALL clarify open points with user.
49
+ You MAY include diagrams, background, and non-normative notes as needed.
50
+ You MAY use todos and tools as needed.
@@ -0,0 +1,48 @@
1
+ # Create or Update Plan(s)
2
+
3
+ ## Bootstrap
4
+
5
+ <tool name="read_file">
6
+ <read path=".awa/.agent/awa.core.md" required="true" error="on not found" />
7
+ <read path=".awa/rules/*.md" required="true" />
8
+ <read path=".awa/specs/ARCHITECTURE.md" required="true" error="on not found" />
9
+ <read path=".awa/.agent/schemas/PLAN.schema.md" required="true" error="on not found" />
10
+ </tool>
11
+
12
+ ## User Input
13
+
14
+ ```text
15
+ ${input}
16
+ ```
17
+
18
+ You **MUST** consider the user input before proceeding (if not empty).
19
+
20
+ ## Inputs
21
+
22
+ <file type="architecture" path=".awa/specs/ARCHITECTURE.md" />
23
+ <file type="feat" path=".awa/specs/FEAT-{CODE}-{feature-name}.md" required="if relevant" />
24
+ <file type="examples" path=".awa/specs/EXAMPLES-{CODE}-{feature-name}-{nnn}.md" required="if relevant" />
25
+ <file type="requirements" path=".awa/specs/REQ-{CODE}-{feature-name}.md" required="if relevant" />
26
+ <file type="design" path=".awa/specs/DESIGN-{CODE}-{feature-name}.md" required="if relevant" />
27
+ <file type="api" path=".awa/specs/API-{CODE}-{feature-name}.md" required="if relevant" />
28
+ <file type="code_and_tests" path="various" required="if relevant" />
29
+
30
+ ## Action
31
+
32
+ Update or create the ad-hoc plan document(s) as specified in the instruction above, following awa conventions.
33
+
34
+ ## Outputs
35
+
36
+ <file path=".awa/plans/PLAN-{nnn}-{plan-name}.md" />
37
+
38
+ ## Rules
39
+
40
+ You SHALL create and maintain ad-hoc plans for features, improvements, refactors, or other user requests.
41
+ You SHALL break down work into detailed, actionable steps
42
+ You SHALL identify risks, dependencies, and completion criteria
43
+ You SHALL ensure the 3-letter {nnn} used in the filename follows the previous plans within the project.
44
+ You SHOULD NOT write significant code in the plan documents. Code can be used to define data structures and for explanation.
45
+ You SHOULD consider edge cases, user experience, technical constraints, and success criteria.
46
+ You SHOULD suggest specific areas where the plan might need clarification or expansion.
47
+ You SHALL clarify open points with user.
48
+ You MAY use todos and tools as needed.