ccgx-workflow 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.
- package/LICENSE +22 -0
- package/README.md +469 -0
- package/README.zh-CN.md +466 -0
- package/bin/ccg.mjs +2 -0
- package/dist/cli.d.mts +1 -0
- package/dist/cli.d.ts +1 -0
- package/dist/cli.mjs +173 -0
- package/dist/index.d.mts +1774 -0
- package/dist/index.d.ts +1774 -0
- package/dist/index.mjs +2029 -0
- package/dist/shared/ccgx-workflow.WgUzkiC3.mjs +5248 -0
- package/package.json +129 -0
- package/templates/commands/agents/assumptions-analyzer.md +129 -0
- package/templates/commands/agents/code-fixer.md +292 -0
- package/templates/commands/agents/codebase-mapper.md +152 -0
- package/templates/commands/agents/debug-session-manager.md +247 -0
- package/templates/commands/agents/debugger.md +111 -0
- package/templates/commands/agents/eval-auditor.md +171 -0
- package/templates/commands/agents/framework-selector.md +152 -0
- package/templates/commands/agents/get-current-datetime.md +29 -0
- package/templates/commands/agents/init-architect.md +114 -0
- package/templates/commands/agents/integration-checker.md +163 -0
- package/templates/commands/agents/interface-auditor.md +170 -0
- package/templates/commands/agents/nyquist-auditor.md +131 -0
- package/templates/commands/agents/pattern-mapper.md +111 -0
- package/templates/commands/agents/phase-runner.md +321 -0
- package/templates/commands/agents/plan-checker.md +255 -0
- package/templates/commands/agents/planner.md +320 -0
- package/templates/commands/agents/team-architect.md +186 -0
- package/templates/commands/agents/team-qa.md +121 -0
- package/templates/commands/agents/team-reviewer.md +157 -0
- package/templates/commands/agents/ui-ux-designer.md +573 -0
- package/templates/commands/agents/verifier.md +274 -0
- package/templates/commands/analyze.md +210 -0
- package/templates/commands/autonomous.md +792 -0
- package/templates/commands/cancel.md +132 -0
- package/templates/commands/clean-branches.md +117 -0
- package/templates/commands/codex-exec.md +404 -0
- package/templates/commands/commit.md +151 -0
- package/templates/commands/context.md +332 -0
- package/templates/commands/debate.md +165 -0
- package/templates/commands/debug.md +226 -0
- package/templates/commands/enhance.md +64 -0
- package/templates/commands/execute.md +380 -0
- package/templates/commands/init.md +123 -0
- package/templates/commands/optimize.md +217 -0
- package/templates/commands/plan.md +373 -0
- package/templates/commands/result.md +106 -0
- package/templates/commands/review.md +338 -0
- package/templates/commands/rollback.md +116 -0
- package/templates/commands/spec-impl.md +139 -0
- package/templates/commands/spec-init.md +101 -0
- package/templates/commands/spec-plan.md +210 -0
- package/templates/commands/spec-research.md +152 -0
- package/templates/commands/spec-review.md +120 -0
- package/templates/commands/status.md +206 -0
- package/templates/commands/team-exec.md +265 -0
- package/templates/commands/test.md +236 -0
- package/templates/commands/verify-work.md +338 -0
- package/templates/commands/verify.md +66 -0
- package/templates/commands/workflow.md +190 -0
- package/templates/commands/worktree.md +128 -0
- package/templates/hooks/ccg-context-monitor.js +159 -0
- package/templates/hooks/ccg-session-state.cjs +510 -0
- package/templates/hooks/ccg-statusline.js +142 -0
- package/templates/output-styles/abyss-command.md +56 -0
- package/templates/output-styles/abyss-concise.md +89 -0
- package/templates/output-styles/abyss-cultivator.md +302 -0
- package/templates/output-styles/abyss-ritual.md +70 -0
- package/templates/output-styles/engineer-professional.md +89 -0
- package/templates/output-styles/laowang-engineer.md +127 -0
- package/templates/output-styles/nekomata-engineer.md +120 -0
- package/templates/output-styles/ojousama-engineer.md +121 -0
- package/templates/prompts/claude/analyzer.md +59 -0
- package/templates/prompts/claude/architect.md +54 -0
- package/templates/prompts/claude/debugger.md +71 -0
- package/templates/prompts/claude/optimizer.md +73 -0
- package/templates/prompts/claude/reviewer.md +63 -0
- package/templates/prompts/claude/tester.md +69 -0
- package/templates/prompts/codex/analyzer.md +58 -0
- package/templates/prompts/codex/architect.md +54 -0
- package/templates/prompts/codex/debugger.md +74 -0
- package/templates/prompts/codex/optimizer.md +81 -0
- package/templates/prompts/codex/reviewer.md +73 -0
- package/templates/prompts/codex/tester.md +62 -0
- package/templates/prompts/gemini/analyzer.md +61 -0
- package/templates/prompts/gemini/architect.md +55 -0
- package/templates/prompts/gemini/debugger.md +78 -0
- package/templates/prompts/gemini/frontend.md +64 -0
- package/templates/prompts/gemini/optimizer.md +84 -0
- package/templates/prompts/gemini/reviewer.md +80 -0
- package/templates/prompts/gemini/tester.md +68 -0
- package/templates/rules/ccg-skill-routing.md +83 -0
- package/templates/rules/ccg-skills.md +71 -0
- package/templates/scripts/ccg-phase-runner-launcher.mjs +467 -0
- package/templates/scripts/invoke-model.mjs +949 -0
- package/templates/scripts/repatch-gemini-plugin.mjs +194 -0
- package/templates/skills/SKILL.md +92 -0
- package/templates/skills/domains/ai/SKILL.md +35 -0
- package/templates/skills/domains/ai/agent-dev.md +242 -0
- package/templates/skills/domains/ai/llm-security.md +288 -0
- package/templates/skills/domains/ai/prompt-and-eval.md +279 -0
- package/templates/skills/domains/ai/rag-system.md +542 -0
- package/templates/skills/domains/architecture/SKILL.md +43 -0
- package/templates/skills/domains/architecture/api-design.md +225 -0
- package/templates/skills/domains/architecture/caching.md +299 -0
- package/templates/skills/domains/architecture/cloud-native.md +285 -0
- package/templates/skills/domains/architecture/message-queue.md +329 -0
- package/templates/skills/domains/architecture/security-arch.md +297 -0
- package/templates/skills/domains/data-engineering/SKILL.md +208 -0
- package/templates/skills/domains/development/SKILL.md +47 -0
- package/templates/skills/domains/development/cpp.md +246 -0
- package/templates/skills/domains/development/go.md +323 -0
- package/templates/skills/domains/development/java.md +277 -0
- package/templates/skills/domains/development/python.md +288 -0
- package/templates/skills/domains/development/rust.md +313 -0
- package/templates/skills/domains/development/shell.md +313 -0
- package/templates/skills/domains/development/typescript.md +277 -0
- package/templates/skills/domains/devops/SKILL.md +40 -0
- package/templates/skills/domains/devops/cost-optimization.md +272 -0
- package/templates/skills/domains/devops/database.md +217 -0
- package/templates/skills/domains/devops/devsecops.md +198 -0
- package/templates/skills/domains/devops/git-workflow.md +181 -0
- package/templates/skills/domains/devops/observability.md +280 -0
- package/templates/skills/domains/devops/performance.md +336 -0
- package/templates/skills/domains/devops/testing.md +283 -0
- package/templates/skills/domains/frontend-design/SKILL.md +244 -0
- package/templates/skills/domains/frontend-design/agents/openai.yaml +4 -0
- package/templates/skills/domains/frontend-design/claymorphism/SKILL.md +121 -0
- package/templates/skills/domains/frontend-design/claymorphism/references/tokens.css +52 -0
- package/templates/skills/domains/frontend-design/component-patterns.md +202 -0
- package/templates/skills/domains/frontend-design/engineering.md +287 -0
- package/templates/skills/domains/frontend-design/glassmorphism/SKILL.md +142 -0
- package/templates/skills/domains/frontend-design/glassmorphism/references/tokens.css +32 -0
- package/templates/skills/domains/frontend-design/liquid-glass/SKILL.md +139 -0
- package/templates/skills/domains/frontend-design/liquid-glass/references/tokens.css +81 -0
- package/templates/skills/domains/frontend-design/neubrutalism/SKILL.md +145 -0
- package/templates/skills/domains/frontend-design/neubrutalism/references/tokens.css +44 -0
- package/templates/skills/domains/frontend-design/reference/color-and-contrast.md +132 -0
- package/templates/skills/domains/frontend-design/reference/interaction-design.md +195 -0
- package/templates/skills/domains/frontend-design/reference/motion-design.md +99 -0
- package/templates/skills/domains/frontend-design/reference/responsive-design.md +114 -0
- package/templates/skills/domains/frontend-design/reference/spatial-design.md +100 -0
- package/templates/skills/domains/frontend-design/reference/typography.md +133 -0
- package/templates/skills/domains/frontend-design/reference/ux-writing.md +107 -0
- package/templates/skills/domains/frontend-design/state-management.md +680 -0
- package/templates/skills/domains/frontend-design/ui-aesthetics.md +110 -0
- package/templates/skills/domains/frontend-design/ux-principles.md +156 -0
- package/templates/skills/domains/infrastructure/SKILL.md +201 -0
- package/templates/skills/domains/mobile/SKILL.md +225 -0
- package/templates/skills/domains/orchestration/SKILL.md +30 -0
- package/templates/skills/domains/orchestration/multi-agent.md +263 -0
- package/templates/skills/domains/security/SKILL.md +73 -0
- package/templates/skills/domains/security/blue-team.md +436 -0
- package/templates/skills/domains/security/code-audit.md +265 -0
- package/templates/skills/domains/security/pentest.md +226 -0
- package/templates/skills/domains/security/red-team.md +374 -0
- package/templates/skills/domains/security/threat-intel.md +372 -0
- package/templates/skills/domains/security/vuln-research.md +369 -0
- package/templates/skills/impeccable/adapt/SKILL.md +201 -0
- package/templates/skills/impeccable/animate/SKILL.md +176 -0
- package/templates/skills/impeccable/arrange/SKILL.md +126 -0
- package/templates/skills/impeccable/audit/SKILL.md +149 -0
- package/templates/skills/impeccable/bolder/SKILL.md +118 -0
- package/templates/skills/impeccable/clarify/SKILL.md +185 -0
- package/templates/skills/impeccable/colorize/SKILL.md +144 -0
- package/templates/skills/impeccable/critique/SKILL.md +203 -0
- package/templates/skills/impeccable/critique/reference/cognitive-load.md +106 -0
- package/templates/skills/impeccable/critique/reference/heuristics-scoring.md +234 -0
- package/templates/skills/impeccable/critique/reference/personas.md +178 -0
- package/templates/skills/impeccable/delight/SKILL.md +305 -0
- package/templates/skills/impeccable/distill/SKILL.md +123 -0
- package/templates/skills/impeccable/extract/SKILL.md +94 -0
- package/templates/skills/impeccable/harden/SKILL.md +357 -0
- package/templates/skills/impeccable/normalize/SKILL.md +72 -0
- package/templates/skills/impeccable/onboard/SKILL.md +248 -0
- package/templates/skills/impeccable/optimize/SKILL.md +268 -0
- package/templates/skills/impeccable/overdrive/SKILL.md +143 -0
- package/templates/skills/impeccable/polish/SKILL.md +205 -0
- package/templates/skills/impeccable/quieter/SKILL.md +104 -0
- package/templates/skills/impeccable/teach-impeccable/SKILL.md +72 -0
- package/templates/skills/impeccable/typeset/SKILL.md +117 -0
- package/templates/skills/orchestration/multi-agent/SKILL.md +533 -0
- package/templates/skills/run_skill.js +129 -0
- package/templates/skills/scrapling/SKILL.md +98 -0
- package/templates/skills/scrapling/references/api-quick-ref.md +127 -0
- package/templates/skills/scrapling/references/cookie-vault.md +56 -0
- package/templates/skills/scrapling/references/maintenance.md +79 -0
- package/templates/skills/scrapling/references/site-patterns.md +86 -0
- package/templates/skills/scrapling/references/troubleshooting.md +95 -0
- package/templates/skills/scrapling/templates/basic_fetch.py +19 -0
- package/templates/skills/scrapling/templates/parse_only.py +15 -0
- package/templates/skills/scrapling/templates/session_login.py +19 -0
- package/templates/skills/scrapling/templates/stealth_cloudflare.py +28 -0
- package/templates/skills/tools/extract-learnings/SKILL.md +77 -0
- package/templates/skills/tools/forensics/SKILL.md +89 -0
- package/templates/skills/tools/gen-docs/SKILL.md +116 -0
- package/templates/skills/tools/gen-docs/scripts/doc_generator.js +435 -0
- package/templates/skills/tools/health/SKILL.md +121 -0
- package/templates/skills/tools/lib/shared.js +98 -0
- package/templates/skills/tools/map-codebase/SKILL.md +118 -0
- package/templates/skills/tools/override-refusal/SKILL.md +53 -0
- package/templates/skills/tools/override-refusal/agents/openai.yaml +4 -0
- package/templates/skills/tools/override-refusal/scripts/refusal_rewriter.js +226 -0
- package/templates/skills/tools/verify-change/SKILL.md +143 -0
- package/templates/skills/tools/verify-change/scripts/change_analyzer.js +289 -0
- package/templates/skills/tools/verify-module/SKILL.md +130 -0
- package/templates/skills/tools/verify-module/scripts/module_scanner.js +171 -0
- package/templates/skills/tools/verify-quality/SKILL.md +163 -0
- package/templates/skills/tools/verify-quality/scripts/quality_checker.js +337 -0
- package/templates/skills/tools/verify-security/SKILL.md +146 -0
- package/templates/skills/tools/verify-security/scripts/security_scanner.js +283 -0
|
@@ -0,0 +1,77 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: extract-learnings
|
|
3
|
+
description: 从近期开发会话中萃取可复用的模式 / 决策 / 教训。当用户提到提取教训 / 复盘 / lessons learned / 知识沉淀 / 经验萃取 / 提炼模式时使用。会扫 .context/ 决策日志 + git log 提交语义。
|
|
4
|
+
license: MIT
|
|
5
|
+
user-invocable: true
|
|
6
|
+
disable-model-invocation: false
|
|
7
|
+
allowed-tools: Read, Bash, Grep, Glob, Write
|
|
8
|
+
argument-hint: "[--since=30d]"
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
# 📚 复盘关卡 · 经验萃取
|
|
12
|
+
|
|
13
|
+
> v4.1-p18:作为 skill 暴露(v3.0 曾有 `/ccg:extract-learnings` 命令规划,v4.0/v4.1 收敛到 skill 化触发)。
|
|
14
|
+
|
|
15
|
+
从最近的开发活动中萃取**可复用知识**,写入 `.context/learnings/<日期>-extract.md`,避免反复踩同坑。
|
|
16
|
+
|
|
17
|
+
## 使用方法
|
|
18
|
+
|
|
19
|
+
```bash
|
|
20
|
+
/ccg:extract-learnings # 默认萃取最近 30 天
|
|
21
|
+
/ccg:extract-learnings --since=14d # 自定义时间窗口
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
## 工作流程
|
|
25
|
+
|
|
26
|
+
### Step 1:收集原料
|
|
27
|
+
|
|
28
|
+
```bash
|
|
29
|
+
# 决策日志
|
|
30
|
+
ls .context/sessions/ 2>/dev/null
|
|
31
|
+
# git 提交(含 commit message)
|
|
32
|
+
git log --since='30.days.ago' --pretty='%h %s' --no-merges
|
|
33
|
+
# 已归档的 phase 报告
|
|
34
|
+
ls .claude/team-plan/*-report.md 2>/dev/null
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
### Step 2:分类萃取
|
|
38
|
+
|
|
39
|
+
按以下五个桶过滤:
|
|
40
|
+
|
|
41
|
+
1. **模式(Pattern)** — 反复出现的好做法("phase 都用 fresh-context subagent 隔离")
|
|
42
|
+
2. **反模式(Anti-pattern)** — 反复犯的错("沙箱里跑 git commit 总被拒")
|
|
43
|
+
3. **决策记录(ADR-like)** — 重要架构决定 + 为什么这么决定
|
|
44
|
+
4. **工具陷阱(Tooling pitfall)** — 工具实际行为 != 文档("Claude Code subagent 不能嵌套 spawn")
|
|
45
|
+
5. **痛点 / 改进点(Pain point)** — 还没解决的待办 / 流程瓶颈
|
|
46
|
+
|
|
47
|
+
### Step 3:写报告
|
|
48
|
+
|
|
49
|
+
```markdown
|
|
50
|
+
# Learnings Extract — <日期范围>
|
|
51
|
+
|
|
52
|
+
**会话数**: N · **commits**: M · **完成 phase**: K
|
|
53
|
+
|
|
54
|
+
## 模式(建议固化)
|
|
55
|
+
1. ...
|
|
56
|
+
|
|
57
|
+
## 反模式(建议警告)
|
|
58
|
+
1. ...
|
|
59
|
+
|
|
60
|
+
## 决策记录
|
|
61
|
+
- **D1: 用 SessionStart hook 注入 roadmap** — 原因:v4.0 主线零项目记忆痛点
|
|
62
|
+
|
|
63
|
+
## 工具陷阱
|
|
64
|
+
- **subagent 不能 spawn 子 agent**(commit a7cdffd 实测)
|
|
65
|
+
|
|
66
|
+
## 痛点
|
|
67
|
+
- ...
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
### Step 4:(可选)建议 PR
|
|
71
|
+
|
|
72
|
+
每条"模式"标记 `→ promote to rules?`,让用户决定是否上升为 `~/.claude/rules/*.md`。
|
|
73
|
+
|
|
74
|
+
## 输出契约
|
|
75
|
+
|
|
76
|
+
- 主输出:`.context/learnings/<YYYY-MM-DD>-extract.md`
|
|
77
|
+
- 终端:每桶 1-3 条精选摘要
|
|
@@ -0,0 +1,89 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: forensics
|
|
3
|
+
description: 代码事件取证 / 提交考古。给定一个文件 / 函数 / bug 现场,反向溯源 git 历史 + 关联 PR / issue / 改动者,重建事故 timeline。当用户提到 git blame / 谁改的 / 为什么这样写 / 提交考古 / 代码取证 / forensics 时使用。
|
|
4
|
+
license: MIT
|
|
5
|
+
user-invocable: true
|
|
6
|
+
disable-model-invocation: false
|
|
7
|
+
allowed-tools: Bash, Read, Grep, Glob, Write
|
|
8
|
+
argument-hint: "<file:line> 或 <function-name>"
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
# 🔬 取证关卡 · 代码考古
|
|
12
|
+
|
|
13
|
+
> v4.1-p18:作为 skill 暴露(v3.0 曾有 `/ccg:forensics` 规划)。
|
|
14
|
+
|
|
15
|
+
给定一段"问题代码"或"已知 bug 现场",反向重建事故时间线:
|
|
16
|
+
|
|
17
|
+
- 这一段最早什么时候引入?哪个 PR?
|
|
18
|
+
- 之后被谁改过?每次改的动机?
|
|
19
|
+
- 周边 commit 是否有相关 hint?
|
|
20
|
+
- 当前形态是否已偏离原始设计意图?
|
|
21
|
+
|
|
22
|
+
## 使用方法
|
|
23
|
+
|
|
24
|
+
```bash
|
|
25
|
+
/ccg:forensics src/foo.ts:42 # 锁定具体行
|
|
26
|
+
/ccg:forensics handleAuth # 锁定函数名
|
|
27
|
+
/ccg:forensics "TODO: fix race" # 锁定特征字符串
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
## 工作流程
|
|
31
|
+
|
|
32
|
+
### Step 1:定位现场
|
|
33
|
+
|
|
34
|
+
如参数是 `file:line` → `git blame -L line,line file`。
|
|
35
|
+
如是函数名 → `grep -rn "<name>" --include="*.{ts,js,py,go,rs}"` 定位首次出现。
|
|
36
|
+
如是特征字符串 → `git log -S "<string>" --pretty='%h %ai %an %s'`(pickaxe)
|
|
37
|
+
|
|
38
|
+
### Step 2:完整 commit 链
|
|
39
|
+
|
|
40
|
+
```bash
|
|
41
|
+
git log --follow --pretty='%h %ai %an %s' -- <file>
|
|
42
|
+
git log -L <line>,+1:<file> # 行级 history
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
### Step 3:关联 PR / issue(如有 GitHub)
|
|
46
|
+
|
|
47
|
+
```bash
|
|
48
|
+
# 从 commit message 提取 (#123) PR 引用
|
|
49
|
+
git log --grep '(#[0-9]\+)' --pretty='%h %s'
|
|
50
|
+
# 如装了 gh CLI:
|
|
51
|
+
gh pr view <num> --json title,body,author,mergedAt
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
### Step 4:周边语义聚类
|
|
55
|
+
|
|
56
|
+
对每个相关 commit `git show --stat <sha>`,看是否同 commit 改了相邻文件 → 有助于推断"当时的工作上下文"。
|
|
57
|
+
|
|
58
|
+
### Step 5:重建 timeline 报告
|
|
59
|
+
|
|
60
|
+
```markdown
|
|
61
|
+
# Forensics Report — <现场标识>
|
|
62
|
+
|
|
63
|
+
**调查时间**: <ISO>
|
|
64
|
+
**当前现场**: src/foo.ts:42 (HEAD)
|
|
65
|
+
|
|
66
|
+
## Timeline
|
|
67
|
+
|
|
68
|
+
| 日期 | commit | author | 动作 | PR | 备注 |
|
|
69
|
+
|------|--------|--------|------|----|------|
|
|
70
|
+
| 2026-01-15 | abc1234 | Alice | 引入 | #45 | 原始设计,handle null |
|
|
71
|
+
| 2026-02-03 | def5678 | Bob | 修改 | #67 | 加 retry 逻辑 |
|
|
72
|
+
| 2026-03-12 | ghi9abc | Carol | 修改 | #88 | 改成异步,**疑似引入 race**|
|
|
73
|
+
|
|
74
|
+
## 当前与原意偏离度
|
|
75
|
+
- 原始:同步 + null check
|
|
76
|
+
- 现在:异步 + 无 mutex → race condition 高风险
|
|
77
|
+
|
|
78
|
+
## 推断 root cause
|
|
79
|
+
**ghi9abc** 把同步改异步时未补 mutex。**修复建议**:加 `pLimit(1)` 或 `Mutex`。
|
|
80
|
+
```
|
|
81
|
+
|
|
82
|
+
### Step 6(可选):写到 .context
|
|
83
|
+
|
|
84
|
+
报告写到 `.context/forensics/<YYYY-MM-DD>-<slug>.md` 持久化,方便后续 `/ccg:debug` 快速复用。
|
|
85
|
+
|
|
86
|
+
## 输出契约
|
|
87
|
+
|
|
88
|
+
- 主输出:`.context/forensics/<YYYY-MM-DD>-<slug>.md`(如 dest 已存在则 append)
|
|
89
|
+
- 终端:timeline 表 + root cause 推断
|
|
@@ -0,0 +1,116 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: gen-docs
|
|
3
|
+
description: 文档生成器。自动分析模块结构,生成 README.md 和 DESIGN.md 骨架。当用户提到生成文档、创建README、创建DESIGN、文档骨架、文档模板时使用。在新建模块开始时自动触发。
|
|
4
|
+
license: MIT
|
|
5
|
+
compatibility: node>=18
|
|
6
|
+
user-invocable: true
|
|
7
|
+
disable-model-invocation: false
|
|
8
|
+
allowed-tools: Bash, Read, Write, Glob
|
|
9
|
+
argument-hint: <模块路径> [--force]
|
|
10
|
+
---
|
|
11
|
+
|
|
12
|
+
# 📝 造典关卡 · 文档生成器
|
|
13
|
+
|
|
14
|
+
|
|
15
|
+
## 核心原则
|
|
16
|
+
|
|
17
|
+
```
|
|
18
|
+
无文档不成模块
|
|
19
|
+
文档是模块的身份证
|
|
20
|
+
没有身份证的模块不允许上线
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
## 自动生成
|
|
24
|
+
|
|
25
|
+
运行文档生成脚本(跨平台):
|
|
26
|
+
|
|
27
|
+
```bash
|
|
28
|
+
# 在 skill 目录下运行
|
|
29
|
+
node scripts/doc_generator.js <模块路径>
|
|
30
|
+
node scripts/doc_generator.js <模块路径> --force # 强制覆盖已存在的文档
|
|
31
|
+
node scripts/doc_generator.js <模块路径> --json # JSON 输出
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
## 生成内容
|
|
35
|
+
|
|
36
|
+
### README.md 骨架
|
|
37
|
+
|
|
38
|
+
自动生成的 README.md 包含:
|
|
39
|
+
|
|
40
|
+
- **模块名称** — 从目录名提取
|
|
41
|
+
- **描述** — 从代码文档字符串提取(如有)
|
|
42
|
+
- **特性列表** — 待填充
|
|
43
|
+
- **依赖** — 从 requirements.txt/pyproject.toml 提取
|
|
44
|
+
- **使用方法** — 基础模板
|
|
45
|
+
- **API 概览** — 从代码提取类和函数列表
|
|
46
|
+
- **目录结构** — 自动扫描生成
|
|
47
|
+
|
|
48
|
+
### DESIGN.md 骨架
|
|
49
|
+
|
|
50
|
+
自动生成的 DESIGN.md 包含:
|
|
51
|
+
|
|
52
|
+
- **设计概述** — 目标与非目标模板
|
|
53
|
+
- **架构设计** — 架构图占位符
|
|
54
|
+
- **核心组件** — 从代码提取类列表
|
|
55
|
+
- **设计决策** — 决策记录表格模板
|
|
56
|
+
- **技术选型** — 自动检测语言和依赖
|
|
57
|
+
- **权衡取舍** — 已知限制和技术债务模板
|
|
58
|
+
- **安全考量** — 威胁模型和安全措施模板
|
|
59
|
+
- **变更历史** — 初始版本记录
|
|
60
|
+
|
|
61
|
+
## 智能分析
|
|
62
|
+
|
|
63
|
+
### 支持的语言
|
|
64
|
+
|
|
65
|
+
| 语言 | 分析能力 |
|
|
66
|
+
|------|----------|
|
|
67
|
+
| **Python** | 类、函数、文档字符串、依赖 |
|
|
68
|
+
| **Go** | 目录结构、依赖 |
|
|
69
|
+
| **TypeScript** | 目录结构、依赖 |
|
|
70
|
+
| **Rust** | 目录结构、依赖 |
|
|
71
|
+
| **其他** | 基础目录结构 |
|
|
72
|
+
|
|
73
|
+
### 提取的信息
|
|
74
|
+
|
|
75
|
+
- 模块名称(目录名)
|
|
76
|
+
- 主要编程语言
|
|
77
|
+
- 代码文件列表
|
|
78
|
+
- 类和函数定义(Python)
|
|
79
|
+
- 文档字符串(Python)
|
|
80
|
+
- 依赖列表
|
|
81
|
+
- 入口点文件
|
|
82
|
+
|
|
83
|
+
## 自动触发时机
|
|
84
|
+
|
|
85
|
+
| 场景 | 触发条件 |
|
|
86
|
+
|------|----------|
|
|
87
|
+
| 新建模块 | 模块创建开始时 |
|
|
88
|
+
| 缺失文档 | 检测到模块缺少文档时 |
|
|
89
|
+
|
|
90
|
+
## 使用流程
|
|
91
|
+
|
|
92
|
+
```
|
|
93
|
+
1. 运行 doc_generator.js 生成骨架
|
|
94
|
+
2. 填充 TODO 标记的内容
|
|
95
|
+
3. 补充设计决策和理由
|
|
96
|
+
4. 添加使用示例
|
|
97
|
+
5. 运行 /verify-module 校验完整性
|
|
98
|
+
```
|
|
99
|
+
|
|
100
|
+
## 生成后检查清单
|
|
101
|
+
|
|
102
|
+
### README.md
|
|
103
|
+
|
|
104
|
+
- [ ] 填充模块描述
|
|
105
|
+
- [ ] 补充特性列表
|
|
106
|
+
- [ ] 添加使用示例
|
|
107
|
+
- [ ] 确认依赖完整
|
|
108
|
+
|
|
109
|
+
### DESIGN.md
|
|
110
|
+
|
|
111
|
+
- [ ] 明确设计目标
|
|
112
|
+
- [ ] 记录设计决策
|
|
113
|
+
- [ ] 说明技术选型理由
|
|
114
|
+
- [ ] 列出已知限制
|
|
115
|
+
|
|
116
|
+
---
|