Loading skill
Install any skill in seconds. Free to start, no credit card required.
Get Started Free →文档生成器。自动分析模块结构,生成 README.md 和 DESIGN.md 骨架。当用户提到生成文档、创建README、创建DESIGN、文档骨架、文档模板时使用。在新建模块开始时自动触发。
| Test case | Without → With | Effect | Δ tokens | Δ turns |
|---|---|---|---|---|
| case-01 | ✗→✓ | ▲ Improved | -37% | 0% |
| case-03 | ✗→✓ | ▲ Improved | 462% | 0% |
| case-07 | ✗→✓ | ▲ Improved | -1% | 0% |
| case-08 | ✗→✓ | ▲ Improved | -33% | 0% |
| case-10 | ✗→✓ | ▲ Improved | -16% | 0% |
无文档不成模块
文档是模块的身份证
没有身份证的模块不允许上线运行文档生成脚本(跨平台):
bash# 在 skill 目录下运行 node scripts/doc_generator.js <模块路径> node scripts/doc_generator.js <模块路径> --force # 强制覆盖已存在的文档 node scripts/doc_generator.js <模块路径> --json # JSON 输出
自动生成的 README.md 包含:
自动生成的 DESIGN.md 包含:
| 语言 | 分析能力 | |------|----------| | Python | 类、函数、文档字符串、依赖 | | Go | 目录结构、依赖 | | TypeScript | 目录结构、依赖 | | Rust | 目录结构、依赖 | | 其他 | 基础目录结构 |
| 场景 | 触发条件 | |------|----------| | 新建模块 | 模块创建开始时 | | 缺失文档 | 检测到模块缺少文档时 |
1. 运行 doc_generator.js 生成骨架
2. 填充 TODO 标记的内容
3. 补充设计决策和理由
4. 添加使用示例
5. 运行 /verify-module 校验完整性Other measured skills in the registry, with their headline benchmark lift.