bobo-ai-cli 1.0.1

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 (234) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +216 -0
  3. package/dist/agent.d.ts +9 -0
  4. package/dist/agent.js +144 -0
  5. package/dist/agent.js.map +1 -0
  6. package/dist/config.d.ts +15 -0
  7. package/dist/config.js +76 -0
  8. package/dist/config.js.map +1 -0
  9. package/dist/index.d.ts +2 -0
  10. package/dist/index.js +366 -0
  11. package/dist/index.js.map +1 -0
  12. package/dist/knowledge-commands.d.ts +2 -0
  13. package/dist/knowledge-commands.js +40 -0
  14. package/dist/knowledge-commands.js.map +1 -0
  15. package/dist/knowledge.d.ts +17 -0
  16. package/dist/knowledge.js +112 -0
  17. package/dist/knowledge.js.map +1 -0
  18. package/dist/memory.d.ts +17 -0
  19. package/dist/memory.js +215 -0
  20. package/dist/memory.js.map +1 -0
  21. package/dist/planner.d.ts +22 -0
  22. package/dist/planner.js +130 -0
  23. package/dist/planner.js.map +1 -0
  24. package/dist/project.d.ts +25 -0
  25. package/dist/project.js +117 -0
  26. package/dist/project.js.map +1 -0
  27. package/dist/rules-commands.d.ts +2 -0
  28. package/dist/rules-commands.js +51 -0
  29. package/dist/rules-commands.js.map +1 -0
  30. package/dist/skills.d.ts +28 -0
  31. package/dist/skills.js +349 -0
  32. package/dist/skills.js.map +1 -0
  33. package/dist/structured/loader.d.ts +19 -0
  34. package/dist/structured/loader.js +147 -0
  35. package/dist/structured/loader.js.map +1 -0
  36. package/dist/structured/paths.d.ts +2 -0
  37. package/dist/structured/paths.js +14 -0
  38. package/dist/structured/paths.js.map +1 -0
  39. package/dist/structured/project-scaffold.d.ts +7 -0
  40. package/dist/structured/project-scaffold.js +60 -0
  41. package/dist/structured/project-scaffold.js.map +1 -0
  42. package/dist/structured/render-markdown.d.ts +37 -0
  43. package/dist/structured/render-markdown.js +47 -0
  44. package/dist/structured/render-markdown.js.map +1 -0
  45. package/dist/structured/render-table.d.ts +1 -0
  46. package/dist/structured/render-table.js +15 -0
  47. package/dist/structured/render-table.js.map +1 -0
  48. package/dist/structured/search.d.ts +10 -0
  49. package/dist/structured/search.js +104 -0
  50. package/dist/structured/search.js.map +1 -0
  51. package/dist/structured/skill-runner.d.ts +15 -0
  52. package/dist/structured/skill-runner.js +60 -0
  53. package/dist/structured/skill-runner.js.map +1 -0
  54. package/dist/structured/types.d.ts +212 -0
  55. package/dist/structured/types.js +97 -0
  56. package/dist/structured/types.js.map +1 -0
  57. package/dist/structured-skills-commands.d.ts +3 -0
  58. package/dist/structured-skills-commands.js +126 -0
  59. package/dist/structured-skills-commands.js.map +1 -0
  60. package/dist/structured-template-commands.d.ts +2 -0
  61. package/dist/structured-template-commands.js +34 -0
  62. package/dist/structured-template-commands.js.map +1 -0
  63. package/dist/tools/index.d.ts +3 -0
  64. package/dist/tools/index.js +450 -0
  65. package/dist/tools/index.js.map +1 -0
  66. package/dist/ui.d.ts +19 -0
  67. package/dist/ui.js +72 -0
  68. package/dist/ui.js.map +1 -0
  69. package/dist/web.d.ts +4 -0
  70. package/dist/web.js +124 -0
  71. package/dist/web.js.map +1 -0
  72. package/knowledge/advanced-patterns.md +70 -0
  73. package/knowledge/agent-directives.md +74 -0
  74. package/knowledge/dream.md +36 -0
  75. package/knowledge/engineering.md +46 -0
  76. package/knowledge/error-catalog.md +33 -0
  77. package/knowledge/index.json +170 -0
  78. package/knowledge/memory/cache-optimization-and-skill-integration.md +102 -0
  79. package/knowledge/memory/engineering-patterns.md +134 -0
  80. package/knowledge/memory/feedback_root_structure.md +16 -0
  81. package/knowledge/memory/project-contexts.md +69 -0
  82. package/knowledge/memory/tools-and-services.md +85 -0
  83. package/knowledge/rules/agents.md +62 -0
  84. package/knowledge/rules/blocking-rules.md +323 -0
  85. package/knowledge/rules/cache-management.md +379 -0
  86. package/knowledge/rules/capability-evolution.md +132 -0
  87. package/knowledge/rules/coding.md +126 -0
  88. package/knowledge/rules/engineering-workflows.md +225 -0
  89. package/knowledge/rules/evomap-content-guidelines.md +354 -0
  90. package/knowledge/rules/evomap-guide.md +224 -0
  91. package/knowledge/rules/git.md +31 -0
  92. package/knowledge/rules/hooks.md +106 -0
  93. package/knowledge/rules/performance.md +101 -0
  94. package/knowledge/rules/remotion-auto-production.md +1120 -0
  95. package/knowledge/rules/security.md +46 -0
  96. package/knowledge/rules/testing.md +32 -0
  97. package/knowledge/rules/work-mode.md +208 -0
  98. package/knowledge/rules.md +62 -0
  99. package/knowledge/skills/Skill_Seekers.md +1722 -0
  100. package/knowledge/skills/ab-test-setup.md +557 -0
  101. package/knowledge/skills/agent-sdk-dev.md +238 -0
  102. package/knowledge/skills/agent-tools.md +136 -0
  103. package/knowledge/skills/analytics-tracking.md +597 -0
  104. package/knowledge/skills/artifacts-builder.md +89 -0
  105. package/knowledge/skills/asana.md +13 -0
  106. package/knowledge/skills/backend-expert.md +97 -0
  107. package/knowledge/skills/brand-voice.md +481 -0
  108. package/knowledge/skills/browser-use.md +419 -0
  109. package/knowledge/skills/cache-optimization-skill.md +179 -0
  110. package/knowledge/skills/canvas-design.md +147 -0
  111. package/knowledge/skills/citation-validator.md +203 -0
  112. package/knowledge/skills/clangd-lsp.md +52 -0
  113. package/knowledge/skills/code-review-expert.md +85 -0
  114. package/knowledge/skills/code-review.md +280 -0
  115. package/knowledge/skills/code-simplifier.md +13 -0
  116. package/knowledge/skills/commit-commands.md +258 -0
  117. package/knowledge/skills/competitor-alternatives.md +795 -0
  118. package/knowledge/skills/content-atomizer.md +910 -0
  119. package/knowledge/skills/content-research-writer.md +605 -0
  120. package/knowledge/skills/context-optimization-suite.md +162 -0
  121. package/knowledge/skills/context7.md +13 -0
  122. package/knowledge/skills/copy-editing.md +494 -0
  123. package/knowledge/skills/copywriting.md +510 -0
  124. package/knowledge/skills/csharp-lsp.md +40 -0
  125. package/knowledge/skills/decision-making-framework.md +154 -0
  126. package/knowledge/skills/developer-growth-analysis.md +335 -0
  127. package/knowledge/skills/direct-response-copy.md +2336 -0
  128. package/knowledge/skills/docker-expert.md +229 -0
  129. package/knowledge/skills/document-skills.md +13 -0
  130. package/knowledge/skills/documentation-expert.md +126 -0
  131. package/knowledge/skills/email-sequence.md +1061 -0
  132. package/knowledge/skills/email-sequences.md +910 -0
  133. package/knowledge/skills/example-plugin.md +72 -0
  134. package/knowledge/skills/explanatory-output-style.md +82 -0
  135. package/knowledge/skills/feature-dev.md +458 -0
  136. package/knowledge/skills/file-organizer.md +466 -0
  137. package/knowledge/skills/firebase.disabled.md +13 -0
  138. package/knowledge/skills/form-cro.md +488 -0
  139. package/knowledge/skills/free-tool-strategy.md +636 -0
  140. package/knowledge/skills/frontend-design-offical.md +55 -0
  141. package/knowledge/skills/frontend-design.md +41 -0
  142. package/knowledge/skills/frontend-expert.md +93 -0
  143. package/knowledge/skills/github.md +13 -0
  144. package/knowledge/skills/gitlab.md +13 -0
  145. package/knowledge/skills/gopls-lsp.md +32 -0
  146. package/knowledge/skills/got-controller.md +218 -0
  147. package/knowledge/skills/greptile.md +72 -0
  148. package/knowledge/skills/hookify.md +376 -0
  149. package/knowledge/skills/image-editor.md +189 -0
  150. package/knowledge/skills/image-enhancer.md +109 -0
  151. package/knowledge/skills/jdtls-lsp.md +49 -0
  152. package/knowledge/skills/json-canvas.md +654 -0
  153. package/knowledge/skills/keyword-research.md +559 -0
  154. package/knowledge/skills/kotlin-lsp.md +28 -0
  155. package/knowledge/skills/laravel-boost.md +13 -0
  156. package/knowledge/skills/launch-strategy.md +394 -0
  157. package/knowledge/skills/lead-magnet.md +393 -0
  158. package/knowledge/skills/learning-output-style.md +106 -0
  159. package/knowledge/skills/linear.md +13 -0
  160. package/knowledge/skills/lua-lsp.md +47 -0
  161. package/knowledge/skills/marketing-ideas.md +720 -0
  162. package/knowledge/skills/marketing-psychology.md +534 -0
  163. package/knowledge/skills/mcp-builder.md +369 -0
  164. package/knowledge/skills/meeting-insights-analyzer.md +347 -0
  165. package/knowledge/skills/memory-evolution-system.md +172 -0
  166. package/knowledge/skills/multi-lens-thinking.md +407 -0
  167. package/knowledge/skills/nano-banana-pro.md +116 -0
  168. package/knowledge/skills/newsletter.md +736 -0
  169. package/knowledge/skills/notebooklm.md +296 -0
  170. package/knowledge/skills/obsidian-bases.md +634 -0
  171. package/knowledge/skills/obsidian-markdown.md +651 -0
  172. package/knowledge/skills/onboarding-cro.md +494 -0
  173. package/knowledge/skills/orchestrator.md +681 -0
  174. package/knowledge/skills/page-cro.md +379 -0
  175. package/knowledge/skills/paid-ads.md +624 -0
  176. package/knowledge/skills/paywall-upgrade-cro.md +651 -0
  177. package/knowledge/skills/php-lsp.md +36 -0
  178. package/knowledge/skills/planning-with-files.md +193 -0
  179. package/knowledge/skills/playwright.md +13 -0
  180. package/knowledge/skills/plugin-dev.md +434 -0
  181. package/knowledge/skills/popup-cro.md +520 -0
  182. package/knowledge/skills/positioning-angles.md +330 -0
  183. package/knowledge/skills/pr-review-toolkit.md +359 -0
  184. package/knowledge/skills/pricing-strategy.md +777 -0
  185. package/knowledge/skills/programmatic-seo.md +714 -0
  186. package/knowledge/skills/pyright-lsp.md +43 -0
  187. package/knowledge/skills/quality-assurance-framework.md +168 -0
  188. package/knowledge/skills/question-refiner.md +160 -0
  189. package/knowledge/skills/ralph-loop.md +205 -0
  190. package/knowledge/skills/refactoring-expert.md +103 -0
  191. package/knowledge/skills/referral-program.md +668 -0
  192. package/knowledge/skills/research-executor.md +164 -0
  193. package/knowledge/skills/review-with-security.md +12 -0
  194. package/knowledge/skills/rust-analyzer-lsp.md +50 -0
  195. package/knowledge/skills/schema-markup.md +647 -0
  196. package/knowledge/skills/security-audit-expert.md +124 -0
  197. package/knowledge/skills/security-expert.md +140 -0
  198. package/knowledge/skills/security-guidance.md +13 -0
  199. package/knowledge/skills/seedance-prompt.md +139 -0
  200. package/knowledge/skills/self-evolution.md +1160 -0
  201. package/knowledge/skills/seo-audit.md +432 -0
  202. package/knowledge/skills/seo-content.md +787 -0
  203. package/knowledge/skills/serena.md +13 -0
  204. package/knowledge/skills/signup-flow-cro.md +409 -0
  205. package/knowledge/skills/skill-creator.md +220 -0
  206. package/knowledge/skills/skill-manager.md +226 -0
  207. package/knowledge/skills/skill-share.md +98 -0
  208. package/knowledge/skills/slack.md +13 -0
  209. package/knowledge/skills/social-content.md +878 -0
  210. package/knowledge/skills/spec-flow-skill.md +124 -0
  211. package/knowledge/skills/stripe.md +13 -0
  212. package/knowledge/skills/supabase.md +13 -0
  213. package/knowledge/skills/swift-lsp.md +40 -0
  214. package/knowledge/skills/synthesizer.md +236 -0
  215. package/knowledge/skills/template-skill.md +16 -0
  216. package/knowledge/skills/testing-expert.md +99 -0
  217. package/knowledge/skills/theme-factory.md +72 -0
  218. package/knowledge/skills/tiktok-research.md +208 -0
  219. package/knowledge/skills/typescript-lsp.md +36 -0
  220. package/knowledge/skills/ui-ux-pro-max.md +247 -0
  221. package/knowledge/skills/verify.md +15 -0
  222. package/knowledge/skills/visual-prompt-engineer.md +102 -0
  223. package/knowledge/skills/webapp-testing.md +111 -0
  224. package/knowledge/skills/wide-research.md +191 -0
  225. package/knowledge/system.md +93 -0
  226. package/knowledge/task-router.md +37 -0
  227. package/knowledge/verification.md +38 -0
  228. package/knowledge/workflows/3d-viz.md +47 -0
  229. package/knowledge/workflows/data-pipeline.md +47 -0
  230. package/knowledge/workflows/db-migration.md +51 -0
  231. package/knowledge/workflows/feature-dev.md +41 -0
  232. package/knowledge/workflows/tdd-flow.md +52 -0
  233. package/knowledge/workflows/ui-verify.md +51 -0
  234. package/package.json +60 -0
@@ -0,0 +1,229 @@
1
+ ---
2
+ id: "docker-expert"
3
+ title: "Docker 专家"
4
+ category: "infrastructure"
5
+ tags: ["docker 专家", "触发时机", "执行流程", "docker 环境检测", "项目结构分析", "容器状态", "构建验证", "安全扫描", "compose 验证", "核心专业领域"]
6
+ triggers: []
7
+ dependencies: []
8
+ source: "E:/Bobo's Coding cache/.claude/skills/docker-expert"
9
+ ---
10
+
11
+ ---
12
+ name: docker-expert
13
+ description: Docker 容器化专家技能。当用户说 "帮我优化 Dockerfile"、"Docker 容器有问题"、"帮我写 docker-compose"、"镜像太大了"、"容器安全加固"、"部署到 Docker"、"容器启动失败"、"Docker 网络问题" 时使用此技能。提供多阶段构建、镜像优化、安全加固、Compose 编排、CI/CD 集成等专业知识。
14
+ category: devops
15
+ color: blue
16
+ displayName: Docker 专家
17
+ version: 2.1.0
18
+ ---
19
+
20
+ # Docker 专家
21
+
22
+ Docker 容器化专家,融合 5 个优秀 Docker 技能的精华,专注于容器优化、安全加固、多阶段构建、编排模式和生产部署策略。
23
+
24
+ ## 触发时机
25
+
26
+ 以下场景调用此技能:
27
+
28
+ - Dockerfile 优化和多阶段构建
29
+ - 容器安全问题和加固
30
+ - Docker Compose 编排配置
31
+ - 镜像体积过大问题
32
+ - 容器网络和服务发现
33
+ - 开发环境容器化
34
+ - CI/CD 流水线集成
35
+ - 容器故障排除
36
+
37
+ ## 执行流程
38
+
39
+ ### 0. 范围检测
40
+
41
+ 超出 Docker 范围时,提示切换专家并停止:
42
+
43
+ - Kubernetes 编排(Pod、Service、Ingress)→ 切换 kubernetes-expert
44
+ - CI/CD 流水线问题 → 切换 github-actions-expert
45
+ - 云服务容器(ECS/Fargate/Cloud Run)→ 切换 devops-expert
46
+ - 数据库容器化(复杂持久化)→ 切换 database-expert
47
+
48
+ 输出示例:
49
+ "这需要 Kubernetes 编排专业知识。请调用 kubernetes-expert。在此停止。"
50
+
51
+ ### 1. 环境分析
52
+
53
+ 优先使用内置工具(Read、Grep、Glob),Shell 命令作为备选。
54
+
55
+ ```bash
56
+ # Docker 环境检测
57
+ docker --version 2>/dev/null || echo "未安装 Docker"
58
+ docker info | grep -E "Server Version|Storage Driver" 2>/dev/null
59
+
60
+ # 项目结构分析
61
+ find . -name "Dockerfile*" -type f | head -10
62
+ find . -name "*compose*.yml" -o -name "*compose*.yaml" -type f | head -5
63
+
64
+ # 容器状态
65
+ docker ps --format "table {{.Names}}\t{{.Image}}\t{{.Status}}" 2>/dev/null | head -10
66
+ ```
67
+
68
+ 分析后调整方案:
69
+
70
+ - 匹配现有 Dockerfile 模式和基础镜像
71
+ - 尊重多阶段构建惯例
72
+ - 区分开发环境与生产环境
73
+ - 考虑现有编排设置(Compose/Swarm)
74
+
75
+ ### 2. 问题诊断与解决
76
+
77
+ 根据问题类型应用对应策略,详细内容参考:
78
+
79
+ - `references/dockerfile-patterns.md` - Dockerfile 优化模式(含 2025 新镜像)
80
+ - `references/compose-orchestration.md` - Compose 编排模式(含 Monorepo)
81
+ - `references/security-hardening.md` - 安全加固指南(含 BuildKit Secrets)
82
+ - `references/cicd-integration.md` - CI/CD 集成(GitHub Actions/GitLab CI)
83
+ - `references/troubleshooting.md` - 故障排除(含平台特定指南)
84
+
85
+ ### 3. 验证
86
+
87
+ ```bash
88
+ # 构建验证
89
+ docker build --no-cache -t test-build . 2>/dev/null && echo "构建成功"
90
+
91
+ # 安全扫描
92
+ docker scout quickview test-build 2>/dev/null || trivy image test-build 2>/dev/null
93
+
94
+ # Compose 验证
95
+ docker-compose config 2>/dev/null && echo "Compose 配置有效"
96
+ ```
97
+
98
+ ---
99
+
100
+ ## 核心专业领域
101
+
102
+ ### 1. 基础镜像选择(2025 推荐)
103
+
104
+ | 优先级 | 镜像类型 | 大小 | 适用场景 |
105
+ | ------ | ---------------- | ----- | -------------------- |
106
+ | 1 | Wolfi/Chainguard | ~10MB | 零 CVE 目标,含 SBOM |
107
+ | 2 | Alpine | ~7MB | 通用,最小攻击面 |
108
+ | 3 | Distroless | ~2MB | 无 shell,最安全 |
109
+ | 4 | Slim | ~70MB | 需要更多系统工具 |
110
+
111
+ **关键规则:**
112
+
113
+ - 始终指定精确版本:`node:20.11.0-alpine3.19`
114
+ - 永远不用 `latest`(不可预测,破坏可复现性)
115
+
116
+ 详细模板和示例参考 `references/dockerfile-patterns.md`
117
+
118
+ ### 2. Dockerfile 优化要点
119
+
120
+ **层缓存优化**:将变化频率低的内容放在前面
121
+
122
+ ```dockerfile
123
+ # 依赖先复制(变化少)
124
+ COPY package*.json ./
125
+ RUN npm ci
126
+ # 源码后复制(变化多)
127
+ COPY . .
128
+ ```
129
+
130
+ **BuildKit 缓存挂载**:加速依赖安装
131
+
132
+ ```dockerfile
133
+ RUN --mount=type=cache,target=/root/.npm npm ci
134
+ ```
135
+
136
+ **安全配置**:非 root 用户 + 健康检查
137
+
138
+ ```dockerfile
139
+ RUN adduser -S appuser -u 1001
140
+ USER 1001
141
+ HEALTHCHECK --interval=30s CMD curl -f http://localhost:3000/health || exit 1
142
+ ```
143
+
144
+ 完整多阶段构建模板参考 `references/dockerfile-patterns.md`
145
+
146
+ ### 3. 容器安全要点
147
+
148
+ - 非 root 用户(指定 UID/GID 1001)
149
+ - BuildKit Secrets 管理(避免镜像层泄露)
150
+ - 能力限制:`--cap-drop=ALL --cap-add=NET_BIND_SERVICE`
151
+ - 只读文件系统:`--read-only --tmpfs /tmp`
152
+
153
+ 详细加固指南参考 `references/security-hardening.md`
154
+
155
+ ### 4. Compose 编排要点
156
+
157
+ - 使用 `depends_on.condition: service_healthy` 确保依赖就绪
158
+ - 网络隔离:`internal: true` 阻止外部访问
159
+ - 资源限制:`deploy.resources.limits`
160
+ - 健康检查:所有服务配置 healthcheck
161
+
162
+ 完整编排模式参考 `references/compose-orchestration.md`
163
+
164
+ ---
165
+
166
+ ## 代码审查清单
167
+
168
+ ### Dockerfile
169
+
170
+ - [ ] 依赖安装与源码分离(层缓存优化)
171
+ - [ ] 多阶段构建分离构建和运行环境
172
+ - [ ] 非 root 用户运行(USER 1001)
173
+ - [ ] Secrets 不在 ENV 或镜像层中
174
+ - [ ] 健康检查已配置
175
+ - [ ] .dockerignore 已优化
176
+ - [ ] 使用精确版本标签(非 latest)
177
+
178
+ ### Compose
179
+
180
+ - [ ] 服务健康检查依赖(condition: service_healthy)
181
+ - [ ] 网络隔离(internal: true)
182
+ - [ ] 资源限制已定义
183
+ - [ ] 重启策略已配置
184
+ - [ ] 日志轮转已配置
185
+
186
+ ### 安全
187
+
188
+ - [ ] 无 --privileged 标志
189
+ - [ ] 无 Docker socket 挂载
190
+ - [ ] 能力已限制(cap-drop=ALL)
191
+ - [ ] 镜像已扫描(Scout/Trivy)
192
+
193
+ ---
194
+
195
+ ## 常见问题快速诊断
196
+
197
+ | 症状 | 可能原因 | 解决方案 |
198
+ | ----------------- | -------------------------- | ---------------------------------- |
199
+ | 构建慢(10+分钟) | 层顺序错误,缓存失效 | 依赖先复制,使用缓存挂载 |
200
+ | 镜像过大(1GB+) | 基础镜像大,构建工具未清理 | 多阶段构建,使用 Alpine/Distroless |
201
+ | 容器立即退出 | 进程崩溃,信号处理错误 | 检查日志,使用 exec 形式 CMD |
202
+ | 网络不通 | 不在同一网络,DNS 解析失败 | 使用服务名,检查网络配置 |
203
+ | 权限拒绝 | 文件所有权错误 | 使用 --chown 复制文件 |
204
+
205
+ 详细诊断流程参考 `references/troubleshooting.md`
206
+
207
+ ---
208
+
209
+ ## 快速命令参考
210
+
211
+ ```bash
212
+ # 开发
213
+ docker-compose up -d # 启动
214
+ docker-compose logs -f app # 日志
215
+ docker-compose exec app sh # 进入容器
216
+
217
+ # 生产
218
+ docker build -t myapp:1.0.0 . # 构建
219
+ docker scout cves myapp:1.0.0 # 安全扫描
220
+ docker stats # 资源监控
221
+
222
+ # 清理
223
+ docker system prune -a # 清理未使用资源
224
+ docker volume prune # 清理未使用卷
225
+
226
+ # 诊断脚本(可选)
227
+ bash scripts/docker-diagnose.sh # 一键诊断
228
+ bash scripts/docker-cleanup.sh # 安全清理
229
+ ```
@@ -0,0 +1,13 @@
1
+ ---
2
+ id: "document-skills"
3
+ title: "document-skills"
4
+ category: "knowledge"
5
+ tags: ["document-skills"]
6
+ triggers: []
7
+ dependencies: []
8
+ source: "E:/Bobo's Coding cache/.claude/skills/document-skills"
9
+ ---
10
+
11
+ # document-skills
12
+
13
+ Skill directory: document-skills
@@ -0,0 +1,126 @@
1
+ ---
2
+ id: "documentation-expert"
3
+ title: "Documentation Expert"
4
+ category: "dev-tools"
5
+ tags: ["documentation expert", "documentation types", "jsdoc/tsdoc patterns", "readme structure", "project name", "features", "installation", "usage", "api reference", "contributing"]
6
+ triggers: []
7
+ dependencies: []
8
+ source: "E:/Bobo's Coding cache/.claude/skills/documentation-expert"
9
+ ---
10
+
11
+ ---
12
+ name: documentation-expert
13
+ description: Expert skill for creating clear, comprehensive documentation for code, APIs, and projects
14
+ ---
15
+
16
+ # Documentation Expert
17
+
18
+ You are an expert technical writer with deep knowledge of documentation best practices, API documentation, and developer experience.
19
+
20
+ ## Documentation Types
21
+
22
+ ### 1. Code Documentation
23
+
24
+ - Inline comments for complex logic
25
+ - JSDoc/TSDoc for functions and classes
26
+ - Module-level documentation
27
+
28
+ ### 2. API Documentation
29
+
30
+ - Endpoint descriptions
31
+ - Request/response examples
32
+ - Error codes and handling
33
+ - Authentication details
34
+
35
+ ### 3. Project Documentation
36
+
37
+ - README files
38
+ - Getting started guides
39
+ - Architecture documentation
40
+ - Contributing guidelines
41
+
42
+ ## JSDoc/TSDoc Patterns
43
+
44
+ ````typescript
45
+ /**
46
+ * Calculates the total price including tax.
47
+ *
48
+ * @param basePrice - The base price before tax
49
+ * @param taxRate - The tax rate as a decimal (e.g., 0.1 for 10%)
50
+ * @returns The total price including tax
51
+ * @throws {Error} If basePrice or taxRate is negative
52
+ *
53
+ * @example
54
+ * ```ts
55
+ * const total = calculateTotal(100, 0.1);
56
+ * console.log(total); // 110
57
+ * ```
58
+ */
59
+ function calculateTotal(basePrice: number, taxRate: number): number {
60
+ // implementation
61
+ }
62
+ ````
63
+
64
+ ## README Structure
65
+
66
+ ```markdown
67
+ # Project Name
68
+
69
+ Brief description of what the project does.
70
+
71
+ ## Features
72
+
73
+ - Feature 1
74
+ - Feature 2
75
+
76
+ ## Installation
77
+
78
+ Step-by-step installation instructions.
79
+
80
+ ## Usage
81
+
82
+ Basic usage examples.
83
+
84
+ ## API Reference
85
+
86
+ Link to detailed API docs.
87
+
88
+ ## Contributing
89
+
90
+ How to contribute to the project.
91
+
92
+ ## License
93
+
94
+ License information.
95
+ ```
96
+
97
+ ## Best Practices
98
+
99
+ 1. **Write for Your Audience**
100
+ - Beginners need more context
101
+ - Experts need quick reference
102
+
103
+ 2. **Use Examples Liberally**
104
+ - Show, don't just tell
105
+ - Include runnable code snippets
106
+
107
+ 3. **Keep Documentation Updated**
108
+ - Document as you code
109
+ - Review docs during code review
110
+
111
+ 4. **Be Concise but Complete**
112
+ - Avoid unnecessary words
113
+ - Don't omit important details
114
+
115
+ ## Output Format
116
+
117
+ ```
118
+ ## Documentation Type
119
+ [Type of documentation being created]
120
+
121
+ ## Content
122
+ [The actual documentation content]
123
+
124
+ ## Usage Examples
125
+ [Practical examples demonstrating usage]
126
+ ```