@maestro-ai/cli 1.0.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 (252) hide show
  1. package/README.md +59 -0
  2. package/content/guides/Cat/303/241logo de Stacks para Cloud Moderna.md" +119 -0
  3. package/content/guides/Cat/303/241logo de Stacks para Hospedagem Compartilhada.md" +147 -0
  4. package/content/guides/Checklist Mestre de Entrega.md +68 -0
  5. package/content/guides/Gates de Qualidade.md +209 -0
  6. package/content/guides/Guia de Adi/303/247/303/243o de Novas Funcionalidades.md" +355 -0
  7. package/content/guides/Guia de Chaos Engineering.md +267 -0
  8. package/content/guides/Guia de Debugging com IA.md +135 -0
  9. package/content/guides/Guia de Estrat/303/251gias de Cache.md" +352 -0
  10. package/content/guides/Guia de Migrations Zero-Downtime.md +311 -0
  11. package/content/guides/Guia de Multi-tenancy.md +368 -0
  12. package/content/guides/Guia de Otimiza/303/247/303/243o de Custos Cloud.md" +195 -0
  13. package/content/guides/Guia de Refatora/303/247/303/243o de C/303/263digo Legado com IA.md" +162 -0
  14. package/content/guides/Guia de SLOs e Error Budgets.md +315 -0
  15. package/content/guides/M/303/251tricas de Efici/303/252ncia do Desenvolvimento com IA.md" +93 -0
  16. package/content/guides/Rules base.md +90 -0
  17. package/content/prompts/README.md +203 -0
  18. package/content/prompts/acessibilidade/analise-acessibilidade.md +257 -0
  19. package/content/prompts/apis/design-api-rest.md +303 -0
  20. package/content/prompts/apis/idempotencia.md +254 -0
  21. package/content/prompts/apis/versionamento.md +313 -0
  22. package/content/prompts/arquitetura/arquitetura-c4-completo.md +190 -0
  23. package/content/prompts/arquitetura/clean-architecture.md +151 -0
  24. package/content/prompts/arquitetura/ddd-bounded-contexts.md +183 -0
  25. package/content/prompts/arquitetura/ddd-cqrs.md +176 -0
  26. package/content/prompts/arquitetura/modelo-dominio.md +207 -0
  27. package/content/prompts/arquitetura/multi-tenancy.md +235 -0
  28. package/content/prompts/database/migrations-zero-downtime.md +192 -0
  29. package/content/prompts/database/otimizacao-queries.md +296 -0
  30. package/content/prompts/desenvolvimento/code-review.md +301 -0
  31. package/content/prompts/desenvolvimento/gerar-servico.md +271 -0
  32. package/content/prompts/devops/docker-compose.md +336 -0
  33. package/content/prompts/devops/feature-flags.md +374 -0
  34. package/content/prompts/devops/kubernetes-deploy.md +460 -0
  35. package/content/prompts/devops/pipeline-cicd.md +358 -0
  36. package/content/prompts/devops/terraform-iac.md +502 -0
  37. package/content/prompts/escalabilidade/analise-performance.md +240 -0
  38. package/content/prompts/escalabilidade/analise-performance.txt +94 -0
  39. package/content/prompts/escalabilidade/caching.md +255 -0
  40. package/content/prompts/observabilidade/chaos-testing.md +237 -0
  41. package/content/prompts/observabilidade/estrategia-observabilidade.md +263 -0
  42. package/content/prompts/observabilidade/estrategia-observabilidade.txt +134 -0
  43. package/content/prompts/observabilidade/slos.md +215 -0
  44. package/content/prompts/produto/discovery-inicial.md +203 -0
  45. package/content/prompts/produto/discovery-inicial.txt +33 -0
  46. package/content/prompts/requisitos/refinar-requisitos.md +232 -0
  47. package/content/prompts/requisitos/refinar-requisitos.txt +40 -0
  48. package/content/prompts/seguranca/analise-seguranca.md +243 -0
  49. package/content/prompts/seguranca/pentest-checklist.md +333 -0
  50. package/content/prompts/seguranca/rate-limiting.md +356 -0
  51. package/content/prompts/seguranca/revisao-lgpd.md +227 -0
  52. package/content/prompts/seguranca/threat-modeling.md +224 -0
  53. package/content/prompts/testes/contract-testing.md +340 -0
  54. package/content/prompts/testes/gerar-testes-unitarios.md +474 -0
  55. package/content/prompts/testes/testes-e2e.md +460 -0
  56. package/content/prompts/testes/testes-integracao.md +418 -0
  57. package/content/prompts/testes/testes-performance.md +458 -0
  58. package/content/prompts/ux/gerar-ui-stitch.md +151 -0
  59. package/content/skills/api-patterns/SKILL.md +81 -0
  60. package/content/skills/api-patterns/api-style.md +42 -0
  61. package/content/skills/api-patterns/auth.md +24 -0
  62. package/content/skills/api-patterns/documentation.md +26 -0
  63. package/content/skills/api-patterns/graphql.md +41 -0
  64. package/content/skills/api-patterns/rate-limiting.md +31 -0
  65. package/content/skills/api-patterns/response.md +37 -0
  66. package/content/skills/api-patterns/rest.md +40 -0
  67. package/content/skills/api-patterns/scripts/api_validator.py +211 -0
  68. package/content/skills/api-patterns/security-testing.md +122 -0
  69. package/content/skills/api-patterns/trpc.md +41 -0
  70. package/content/skills/api-patterns/versioning.md +22 -0
  71. package/content/skills/app-builder/SKILL.md +75 -0
  72. package/content/skills/app-builder/agent-coordination.md +71 -0
  73. package/content/skills/app-builder/feature-building.md +53 -0
  74. package/content/skills/app-builder/project-detection.md +34 -0
  75. package/content/skills/app-builder/scaffolding.md +118 -0
  76. package/content/skills/app-builder/tech-stack.md +40 -0
  77. package/content/skills/app-builder/templates/SKILL.md +39 -0
  78. package/content/skills/app-builder/templates/astro-static/TEMPLATE.md +76 -0
  79. package/content/skills/app-builder/templates/chrome-extension/TEMPLATE.md +92 -0
  80. package/content/skills/app-builder/templates/cli-tool/TEMPLATE.md +88 -0
  81. package/content/skills/app-builder/templates/electron-desktop/TEMPLATE.md +88 -0
  82. package/content/skills/app-builder/templates/express-api/TEMPLATE.md +83 -0
  83. package/content/skills/app-builder/templates/flutter-app/TEMPLATE.md +90 -0
  84. package/content/skills/app-builder/templates/monorepo-turborepo/TEMPLATE.md +90 -0
  85. package/content/skills/app-builder/templates/nextjs-fullstack/TEMPLATE.md +82 -0
  86. package/content/skills/app-builder/templates/nextjs-saas/TEMPLATE.md +100 -0
  87. package/content/skills/app-builder/templates/nextjs-static/TEMPLATE.md +106 -0
  88. package/content/skills/app-builder/templates/nuxt-app/TEMPLATE.md +101 -0
  89. package/content/skills/app-builder/templates/python-fastapi/TEMPLATE.md +83 -0
  90. package/content/skills/app-builder/templates/react-native-app/TEMPLATE.md +93 -0
  91. package/content/skills/architecture/SKILL.md +55 -0
  92. package/content/skills/architecture/context-discovery.md +43 -0
  93. package/content/skills/architecture/examples.md +94 -0
  94. package/content/skills/architecture/pattern-selection.md +68 -0
  95. package/content/skills/architecture/patterns-reference.md +50 -0
  96. package/content/skills/architecture/trade-off-analysis.md +77 -0
  97. package/content/skills/bash-linux/SKILL.md +199 -0
  98. package/content/skills/behavioral-modes/SKILL.md +242 -0
  99. package/content/skills/brainstorming/SKILL.md +163 -0
  100. package/content/skills/brainstorming/dynamic-questioning.md +350 -0
  101. package/content/skills/clean-code/SKILL.md +201 -0
  102. package/content/skills/code-review-checklist/SKILL.md +109 -0
  103. package/content/skills/database-design/SKILL.md +52 -0
  104. package/content/skills/database-design/database-selection.md +43 -0
  105. package/content/skills/database-design/indexing.md +39 -0
  106. package/content/skills/database-design/migrations.md +48 -0
  107. package/content/skills/database-design/optimization.md +36 -0
  108. package/content/skills/database-design/orm-selection.md +30 -0
  109. package/content/skills/database-design/schema-design.md +56 -0
  110. package/content/skills/database-design/scripts/schema_validator.py +172 -0
  111. package/content/skills/deployment-procedures/SKILL.md +241 -0
  112. package/content/skills/doc.md +177 -0
  113. package/content/skills/documentation-templates/SKILL.md +194 -0
  114. package/content/skills/frontend-design/SKILL.md +396 -0
  115. package/content/skills/frontend-design/animation-guide.md +331 -0
  116. package/content/skills/frontend-design/color-system.md +311 -0
  117. package/content/skills/frontend-design/decision-trees.md +418 -0
  118. package/content/skills/frontend-design/motion-graphics.md +306 -0
  119. package/content/skills/frontend-design/scripts/accessibility_checker.py +183 -0
  120. package/content/skills/frontend-design/scripts/ux_audit.py +722 -0
  121. package/content/skills/frontend-design/typography-system.md +345 -0
  122. package/content/skills/frontend-design/ux-psychology.md +541 -0
  123. package/content/skills/frontend-design/visual-effects.md +383 -0
  124. package/content/skills/game-development/2d-games/SKILL.md +119 -0
  125. package/content/skills/game-development/3d-games/SKILL.md +135 -0
  126. package/content/skills/game-development/SKILL.md +167 -0
  127. package/content/skills/game-development/game-art/SKILL.md +185 -0
  128. package/content/skills/game-development/game-audio/SKILL.md +190 -0
  129. package/content/skills/game-development/game-design/SKILL.md +129 -0
  130. package/content/skills/game-development/mobile-games/SKILL.md +108 -0
  131. package/content/skills/game-development/multiplayer/SKILL.md +132 -0
  132. package/content/skills/game-development/pc-games/SKILL.md +144 -0
  133. package/content/skills/game-development/vr-ar/SKILL.md +123 -0
  134. package/content/skills/game-development/web-games/SKILL.md +150 -0
  135. package/content/skills/geo-fundamentals/SKILL.md +156 -0
  136. package/content/skills/geo-fundamentals/scripts/geo_checker.py +289 -0
  137. package/content/skills/i18n-localization/SKILL.md +154 -0
  138. package/content/skills/i18n-localization/scripts/i18n_checker.py +241 -0
  139. package/content/skills/intelligent-routing/SKILL.md +334 -0
  140. package/content/skills/lint-and-validate/SKILL.md +45 -0
  141. package/content/skills/lint-and-validate/scripts/lint_runner.py +172 -0
  142. package/content/skills/lint-and-validate/scripts/type_coverage.py +173 -0
  143. package/content/skills/mcp-builder/SKILL.md +176 -0
  144. package/content/skills/mobile-design/SKILL.md +394 -0
  145. package/content/skills/mobile-design/decision-trees.md +516 -0
  146. package/content/skills/mobile-design/mobile-backend.md +491 -0
  147. package/content/skills/mobile-design/mobile-color-system.md +420 -0
  148. package/content/skills/mobile-design/mobile-debugging.md +122 -0
  149. package/content/skills/mobile-design/mobile-design-thinking.md +357 -0
  150. package/content/skills/mobile-design/mobile-navigation.md +458 -0
  151. package/content/skills/mobile-design/mobile-performance.md +767 -0
  152. package/content/skills/mobile-design/mobile-testing.md +356 -0
  153. package/content/skills/mobile-design/mobile-typography.md +433 -0
  154. package/content/skills/mobile-design/platform-android.md +666 -0
  155. package/content/skills/mobile-design/platform-ios.md +561 -0
  156. package/content/skills/mobile-design/scripts/mobile_audit.py +670 -0
  157. package/content/skills/mobile-design/touch-psychology.md +537 -0
  158. package/content/skills/nextjs-best-practices/SKILL.md +203 -0
  159. package/content/skills/nodejs-best-practices/SKILL.md +333 -0
  160. package/content/skills/parallel-agents/SKILL.md +175 -0
  161. package/content/skills/performance-profiling/SKILL.md +143 -0
  162. package/content/skills/performance-profiling/scripts/lighthouse_audit.py +76 -0
  163. package/content/skills/plan-writing/SKILL.md +152 -0
  164. package/content/skills/powershell-windows/SKILL.md +167 -0
  165. package/content/skills/python-patterns/SKILL.md +441 -0
  166. package/content/skills/react-patterns/SKILL.md +198 -0
  167. package/content/skills/red-team-tactics/SKILL.md +199 -0
  168. package/content/skills/seo-fundamentals/SKILL.md +129 -0
  169. package/content/skills/seo-fundamentals/scripts/seo_checker.py +219 -0
  170. package/content/skills/server-management/SKILL.md +161 -0
  171. package/content/skills/systematic-debugging/SKILL.md +109 -0
  172. package/content/skills/tailwind-patterns/SKILL.md +269 -0
  173. package/content/skills/tdd-workflow/SKILL.md +149 -0
  174. package/content/skills/testing-patterns/SKILL.md +178 -0
  175. package/content/skills/testing-patterns/scripts/test_runner.py +219 -0
  176. package/content/skills/vulnerability-scanner/SKILL.md +276 -0
  177. package/content/skills/vulnerability-scanner/checklists.md +121 -0
  178. package/content/skills/vulnerability-scanner/scripts/security_scan.py +458 -0
  179. package/content/skills/webapp-testing/SKILL.md +187 -0
  180. package/content/skills/webapp-testing/scripts/playwright_runner.py +173 -0
  181. package/content/specialists/Especialista em Acessibilidade.md +266 -0
  182. package/content/specialists/Especialista em An/303/241lise de Testes.md" +434 -0
  183. package/content/specialists/Especialista em Arquitetura Avan/303/247ada.md" +358 -0
  184. package/content/specialists/Especialista em Arquitetura de Software.md +177 -0
  185. package/content/specialists/Especialista em Banco de Dados.md +260 -0
  186. package/content/specialists/Especialista em Contrato de API.md +172 -0
  187. package/content/specialists/Especialista em Dados e Analytics com IA.md +246 -0
  188. package/content/specialists/Especialista em Debugging e Troubleshooting.md +191 -0
  189. package/content/specialists/Especialista em Desenvolvimento Frontend.md +477 -0
  190. package/content/specialists/Especialista em Desenvolvimento Mobile.md +241 -0
  191. package/content/specialists/Especialista em Desenvolvimento e Vibe Coding Estruturado.md +417 -0
  192. package/content/specialists/Especialista em DevOps e Infraestrutura.md +294 -0
  193. package/content/specialists/Especialista em Documenta/303/247/303/243o T/303/251cnica.md" +227 -0
  194. package/content/specialists/Especialista em Engenharia de Requisitos com IA.md +299 -0
  195. package/content/specialists/Especialista em Explora/303/247/303/243o de Codebase.md" +179 -0
  196. package/content/specialists/Especialista em Gest/303/243o de Produto.md" +179 -0
  197. package/content/specialists/Especialista em Migra/303/247/303/243o e Moderniza/303/247/303/243o.md" +410 -0
  198. package/content/specialists/Especialista em Modelagem e Arquitetura de Dom/303/255nio com IA.md" +248 -0
  199. package/content/specialists/Especialista em Observabilidade.md +415 -0
  200. package/content/specialists/Especialista em Performance e Escalabilidade.md +373 -0
  201. package/content/specialists/Especialista em Plano de Execu/303/247/303/243o com IA.md" +341 -0
  202. package/content/specialists/Especialista em Prototipagem R/303/241pida com Google Stitch.md" +419 -0
  203. package/content/specialists/Especialista em Seguran/303/247a da Informa/303/247/303/243o.md" +508 -0
  204. package/content/specialists/Especialista em UX Design.md +453 -0
  205. package/content/specialists/INDEX.md +43 -0
  206. package/content/templates/PRD.md +165 -0
  207. package/content/templates/README.md +65 -0
  208. package/content/templates/adr.md +103 -0
  209. package/content/templates/arquitetura.md +279 -0
  210. package/content/templates/backlog.md +185 -0
  211. package/content/templates/checklist-seguranca.md +180 -0
  212. package/content/templates/contexto.md +120 -0
  213. package/content/templates/criterios-aceite.md +99 -0
  214. package/content/templates/design-banco.md +270 -0
  215. package/content/templates/design-doc.md +240 -0
  216. package/content/templates/feature.md +88 -0
  217. package/content/templates/historia-backend.md +84 -0
  218. package/content/templates/historia-frontend.md +75 -0
  219. package/content/templates/historia-usuario.md +125 -0
  220. package/content/templates/mapa-navegacao.md +133 -0
  221. package/content/templates/matriz-rastreabilidade.md +121 -0
  222. package/content/templates/modelo-dominio.md +219 -0
  223. package/content/templates/plano-testes.md +199 -0
  224. package/content/templates/prototipo-stitch.md +138 -0
  225. package/content/templates/requisitos.md +162 -0
  226. package/content/templates/slo-sli.md +197 -0
  227. package/content/workflows/README-MCP.md +363 -0
  228. package/content/workflows/brainstorm.md +113 -0
  229. package/content/workflows/create.md +59 -0
  230. package/content/workflows/debug.md +103 -0
  231. package/content/workflows/deploy.md +176 -0
  232. package/content/workflows/enhance.md +63 -0
  233. package/content/workflows/mcp-debug.md +506 -0
  234. package/content/workflows/mcp-feature.md +385 -0
  235. package/content/workflows/mcp-gate.md +413 -0
  236. package/content/workflows/mcp-next.md +388 -0
  237. package/content/workflows/mcp-refactor.md +600 -0
  238. package/content/workflows/mcp-start.md +304 -0
  239. package/content/workflows/mcp-status.md +400 -0
  240. package/content/workflows/orchestrate.md +237 -0
  241. package/content/workflows/plan.md +89 -0
  242. package/content/workflows/preview.md +81 -0
  243. package/content/workflows/status.md +86 -0
  244. package/content/workflows/test.md +144 -0
  245. package/content/workflows/ui-ux-pro-max.md +296 -0
  246. package/dist/commands/init.d.ts +6 -0
  247. package/dist/commands/init.js +138 -0
  248. package/dist/commands/update.d.ts +5 -0
  249. package/dist/commands/update.js +50 -0
  250. package/dist/index.d.ts +2 -0
  251. package/dist/index.js +21 -0
  252. package/package.json +48 -0
@@ -0,0 +1,177 @@
1
+ # Antigravity Skills
2
+
3
+ > **Hướng dẫn tạo và sử dụng Skills trong Antigravity Kit**
4
+
5
+ ---
6
+
7
+ ## 📋 Giới thiệu
8
+
9
+ Mặc dù các mô hình cơ bản của Antigravity (như Gemini) là những mô hình đa năng mạnh mẽ, nhưng chúng không biết ngữ cảnh dự án cụ thể hoặc các tiêu chuẩn của nhóm bạn. Việc tải từng quy tắc hoặc công cụ vào cửa sổ ngữ cảnh của tác nhân sẽ dẫn đến tình trạng "phình to công cụ", chi phí cao hơn, độ trễ và sự nhầm lẫn.
10
+
11
+ **Antigravity Skills** giải quyết vấn đề này thông qua tính năng **Progressive Disclosure**. Kỹ năng là một gói kiến thức chuyên biệt, ở trạng thái không hoạt động cho đến khi cần. Thông tin này chỉ được tải vào ngữ cảnh của tác nhân khi yêu cầu cụ thể của bạn khớp với nội dung mô tả của kỹ năng.
12
+
13
+ ---
14
+
15
+ ## 📁 Cấu trúc và Phạm vi
16
+
17
+ Kỹ năng là các gói dựa trên thư mục. Bạn có thể xác định các phạm vi này tuỳ thuộc vào nhu cầu:
18
+
19
+ | Phạm vi | Đường dẫn | Mô tả |
20
+ |---------|-----------|-------|
21
+ | **Workspace** | `<workspace-root>/.agent/skills/` | Chỉ có trong một dự án cụ thể |
22
+
23
+ ### Cấu trúc thư mục kỹ năng
24
+
25
+ ```
26
+ my-skill/
27
+ ├── SKILL.md # (Required) Metadata & instructions
28
+ ├── scripts/ # (Optional) Python or Bash scripts
29
+ ├── references/ # (Optional) Text, documentation, templates
30
+ └── assets/ # (Optional) Images or logos
31
+ ```
32
+
33
+ ---
34
+
35
+ ## 🔍 Ví dụ 1: Code Review Skill
36
+
37
+ Đây là một kỹ năng chỉ có hướng dẫn (instruction-only), chỉ cần tạo file `SKILL.md`.
38
+
39
+ ### Bước 1: Tạo thư mục
40
+
41
+ ```bash
42
+ mkdir -p ~/.gemini/antigravity/skills/code-review
43
+ ```
44
+
45
+ ### Bước 2: Tạo SKILL.md
46
+
47
+ ```markdown
48
+ ---
49
+ name: code-review
50
+ description: Reviews code changes for bugs, style issues, and best practices. Use when reviewing PRs or checking code quality.
51
+ ---
52
+
53
+ # Code Review Skill
54
+
55
+ When reviewing code, follow these steps:
56
+
57
+ ## Review checklist
58
+
59
+ 1. **Correctness**: Does the code do what it's supposed to?
60
+ 2. **Edge cases**: Are error conditions handled?
61
+ 3. **Style**: Does it follow project conventions?
62
+ 4. **Performance**: Are there obvious inefficiencies?
63
+
64
+ ## How to provide feedback
65
+
66
+ - Be specific about what needs to change
67
+ - Explain why, not just what
68
+ - Suggest alternatives when possible
69
+ ```
70
+
71
+ > **Lưu ý**: File `SKILL.md` chứa siêu dữ liệu (name, description) ở trên cùng, sau đó là các chỉ dẫn. Agent sẽ chỉ đọc siêu dữ liệu và chỉ tải hướng dẫn khi cần.
72
+
73
+ ### Dùng thử
74
+
75
+ Tạo file `demo_bad_code.py`:
76
+
77
+ ```python
78
+ import time
79
+
80
+ def get_user_data(users, id):
81
+ # Find user by ID
82
+ for u in users:
83
+ if u['id'] == id:
84
+ return u
85
+ return None
86
+
87
+ def process_payments(items):
88
+ total = 0
89
+ for i in items:
90
+ # Calculate tax
91
+ tax = i['price'] * 0.1
92
+ total = total + i['price'] + tax
93
+ time.sleep(0.1) # Simulate slow network call
94
+ return total
95
+
96
+ def run_batch():
97
+ users = [{'id': 1, 'name': 'Alice'}, {'id': 2, 'name': 'Bob'}]
98
+ items = [{'price': 10}, {'price': 20}, {'price': 100}]
99
+
100
+ u = get_user_data(users, 3)
101
+ print("User found: " + u['name']) # Will crash if None
102
+
103
+ print("Total: " + str(process_payments(items)))
104
+
105
+ if __name__ == "__main__":
106
+ run_batch()
107
+ ```
108
+
109
+ **Prompt**: `review the @demo_bad_code.py file`
110
+
111
+ Agent sẽ tự động xác định kỹ năng `code-review`, tải thông tin và thực hiện theo hướng dẫn.
112
+
113
+ ---
114
+
115
+ ## 📄 Ví dụ 2: License Header Skill
116
+
117
+ Kỹ năng này sử dụng file tham chiếu (reference file) trong thư mục `resources/`.
118
+
119
+ ### Bước 1: Tạo thư mục
120
+
121
+ ```bash
122
+ mkdir -p .agent/skills/license-header-adder/resources
123
+ ```
124
+
125
+ ### Bước 2: Tạo file template
126
+
127
+ **`.agent/skills/license-header-adder/resources/HEADER.txt`**:
128
+
129
+ ```
130
+ /*
131
+ * Copyright (c) 2026 YOUR_COMPANY_NAME LLC.
132
+ * All rights reserved.
133
+ * This code is proprietary and confidential.
134
+ */
135
+ ```
136
+
137
+ ### Bước 3: Tạo SKILL.md
138
+
139
+ **`.agent/skills/license-header-adder/SKILL.md`**:
140
+
141
+ ```markdown
142
+ ---
143
+ name: license-header-adder
144
+ description: Adds the standard corporate license header to new source files.
145
+ ---
146
+
147
+ # License Header Adder
148
+
149
+ This skill ensures that all new source files have the correct copyright header.
150
+
151
+ ## Instructions
152
+
153
+ 1. **Read the Template**: Read the content of `resources/HEADER.txt`.
154
+ 2. **Apply to File**: When creating a new file, prepend this exact content.
155
+ 3. **Adapt Syntax**:
156
+ - For C-style languages (Java, TS), keep the `/* */` block.
157
+ - For Python/Shell, convert to `#` comments.
158
+ ```
159
+
160
+ ### Dùng thử
161
+
162
+ **Prompt**: `Create a new Python script named data_processor.py that prints 'Hello World'.`
163
+
164
+ Agent sẽ đọc template, chuyển đổi comments theo kiểu Python và tự động thêm vào đầu file.
165
+
166
+ ---
167
+
168
+ ## 🎯 Kết luận
169
+
170
+ Bằng cách tạo Skills, bạn đã biến mô hình AI đa năng thành một chuyên gia cho dự án của mình:
171
+
172
+ - ✅ Hệ thống hoá các best practices
173
+ - ✅ Tuân theo quy tắc đánh giá code
174
+ - ✅ Tự động thêm license headers
175
+ - ✅ Agent tự động biết cách làm việc với nhóm của bạn
176
+
177
+ Thay vì liên tục nhắc AI "nhớ thêm license" hoặc "sửa format commit", giờ đây Agent sẽ tự động thực hiện!
@@ -0,0 +1,194 @@
1
+ ---
2
+ name: documentation-templates
3
+ description: Documentation templates and structure guidelines. README, API docs, code comments, and AI-friendly documentation.
4
+ allowed-tools: Read, Glob, Grep
5
+ ---
6
+
7
+ # Documentation Templates
8
+
9
+ > Templates and structure guidelines for common documentation types.
10
+
11
+ ---
12
+
13
+ ## 1. README Structure
14
+
15
+ ### Essential Sections (Priority Order)
16
+
17
+ | Section | Purpose |
18
+ |---------|---------|
19
+ | **Title + One-liner** | What is this? |
20
+ | **Quick Start** | Running in <5 min |
21
+ | **Features** | What can I do? |
22
+ | **Configuration** | How to customize |
23
+ | **API Reference** | Link to detailed docs |
24
+ | **Contributing** | How to help |
25
+ | **License** | Legal |
26
+
27
+ ### README Template
28
+
29
+ ```markdown
30
+ # Project Name
31
+
32
+ Brief one-line description.
33
+
34
+ ## Quick Start
35
+
36
+ [Minimum steps to run]
37
+
38
+ ## Features
39
+
40
+ - Feature 1
41
+ - Feature 2
42
+
43
+ ## Configuration
44
+
45
+ | Variable | Description | Default |
46
+ |----------|-------------|---------|
47
+ | PORT | Server port | 3000 |
48
+
49
+ ## Documentation
50
+
51
+ - [API Reference](./docs/api.md)
52
+ - [Architecture](./docs/architecture.md)
53
+
54
+ ## License
55
+
56
+ MIT
57
+ ```
58
+
59
+ ---
60
+
61
+ ## 2. API Documentation Structure
62
+
63
+ ### Per-Endpoint Template
64
+
65
+ ```markdown
66
+ ## GET /users/:id
67
+
68
+ Get a user by ID.
69
+
70
+ **Parameters:**
71
+ | Name | Type | Required | Description |
72
+ |------|------|----------|-------------|
73
+ | id | string | Yes | User ID |
74
+
75
+ **Response:**
76
+ - 200: User object
77
+ - 404: User not found
78
+
79
+ **Example:**
80
+ [Request and response example]
81
+ ```
82
+
83
+ ---
84
+
85
+ ## 3. Code Comment Guidelines
86
+
87
+ ### JSDoc/TSDoc Template
88
+
89
+ ```typescript
90
+ /**
91
+ * Brief description of what the function does.
92
+ *
93
+ * @param paramName - Description of parameter
94
+ * @returns Description of return value
95
+ * @throws ErrorType - When this error occurs
96
+ *
97
+ * @example
98
+ * const result = functionName(input);
99
+ */
100
+ ```
101
+
102
+ ### When to Comment
103
+
104
+ | ✅ Comment | ❌ Don't Comment |
105
+ |-----------|-----------------|
106
+ | Why (business logic) | What (obvious) |
107
+ | Complex algorithms | Every line |
108
+ | Non-obvious behavior | Self-explanatory code |
109
+ | API contracts | Implementation details |
110
+
111
+ ---
112
+
113
+ ## 4. Changelog Template (Keep a Changelog)
114
+
115
+ ```markdown
116
+ # Changelog
117
+
118
+ ## [Unreleased]
119
+ ### Added
120
+ - New feature
121
+
122
+ ## [1.0.0] - 2025-01-01
123
+ ### Added
124
+ - Initial release
125
+ ### Changed
126
+ - Updated dependency
127
+ ### Fixed
128
+ - Bug fix
129
+ ```
130
+
131
+ ---
132
+
133
+ ## 5. Architecture Decision Record (ADR)
134
+
135
+ ```markdown
136
+ # ADR-001: [Title]
137
+
138
+ ## Status
139
+ Accepted / Deprecated / Superseded
140
+
141
+ ## Context
142
+ Why are we making this decision?
143
+
144
+ ## Decision
145
+ What did we decide?
146
+
147
+ ## Consequences
148
+ What are the trade-offs?
149
+ ```
150
+
151
+ ---
152
+
153
+ ## 6. AI-Friendly Documentation (2025)
154
+
155
+ ### llms.txt Template
156
+
157
+ For AI crawlers and agents:
158
+
159
+ ```markdown
160
+ # Project Name
161
+ > One-line objective.
162
+
163
+ ## Core Files
164
+ - [src/index.ts]: Main entry
165
+ - [src/api/]: API routes
166
+ - [docs/]: Documentation
167
+
168
+ ## Key Concepts
169
+ - Concept 1: Brief explanation
170
+ - Concept 2: Brief explanation
171
+ ```
172
+
173
+ ### MCP-Ready Documentation
174
+
175
+ For RAG indexing:
176
+ - Clear H1-H3 hierarchy
177
+ - JSON/YAML examples for data structures
178
+ - Mermaid diagrams for flows
179
+ - Self-contained sections
180
+
181
+ ---
182
+
183
+ ## 7. Structure Principles
184
+
185
+ | Principle | Why |
186
+ |-----------|-----|
187
+ | **Scannable** | Headers, lists, tables |
188
+ | **Examples first** | Show, don't just tell |
189
+ | **Progressive detail** | Simple → Complex |
190
+ | **Up to date** | Outdated = misleading |
191
+
192
+ ---
193
+
194
+ > **Remember:** Templates are starting points. Adapt to your project's needs.