文档
- 作者仓库星标 5,436
- 许可证 MIT
- 作者仓库 ccg-workflow
- 领域
- 设计与多媒体
- 作者声明的智能体
- 未找到明确声明;不据此推断已兼容或已测试
- 静态检查
- 94 / 100 · 启发式扫描,不代表运行安全
- 运行环境证据
- 未执行;当前没有隔离运行测试证据
- 作者 / 版本 / 许可证
- @fengshao1227 · MIT
- 上下文用量评级
- 低消耗
- 接入复杂程度
- 需简单配置
- 是否需要外部接口密钥
- 不需要
- 兼容的系统
- macOS · Linux · Windows
- 运行环境要求
- Node.js · Python
- 检测到的文件与系统行为
-
- 只读
- 网络行为
- 仅限本地
- 安装命令数
- 无(仅作为资料)
需要注意: 未声明工具权限范围;实际权限由运行环境决定。
# 📝 造典关卡 · 文档生成器
## 核心原则
```
无文档不成模块
文档是模块的身份证
没有身份证的模块不允许上线
```
## 自动生成
运行文档生成脚本(跨平台):
```bash
# 在 skill 目录下运行
node scripts/doc_generator.js <模块路径>
node scripts/doc_generator.js <模块路径> --force # 强制覆盖已存在的文档
node scripts/doc_generator.js <模块路径> --json # JSON 输出
```
## 生成内容
### README.md 骨架
自动生成的 README.md 包含:
- **模块名称** — 从目录名提取
- **描述** — 从代码文档字符串提取(如有)
- **特性列表** — 待填充
- **依赖** — 从 requirements.txt/pyproject.toml 提取
- **使用方法** — 基础模板
- **API 概览** — 从代码提取类和函数列表
- **目录结构** — 自动扫描生成
### DESIGN.md 骨架
自动生成的 DESIGN.md 包含:
- **设计概述** — 目标与非目标模板
- **架构设计** — 架构图占位符
- **核心组件** — 从代码提取类列表
- **设计决策** — 决策记录表格模板
- **技术选型** — 自动检测语言和依赖
- **权衡取舍** — 已知限制和技术债务模板
- **安全考量** — 威胁模型和安全措施模板
- **变更历史** — 初始版本记录
## 智能分析
### 支持的语言
| 语言 | 分析能力 |
|------|----------|
| **Python** | 类、函数、文档字符串、依赖 |
| **Go** | 目录结构、依赖 |
| **TypeScript** | 目录结构、依赖 |
| **Rust** | 目录结构、依赖 |
| **其他** | 基础目录结构 |
### 提取的信息
- 模块名称(目录名)
- 主要编程语言
- 代码文件列表
- 类和函数定义(Python)
- 文档字符串(Python)
- 依赖列表
- 入口点文件
## 自动触发时机
| 场景 | 触发条件 |
|------|----------|
| 新建模块 | 模块创建开始时 |
| 缺失文档 | 检测到模块缺少文档时 |
## 使用流程
```
1. 运行 doc_generator.js 生成骨架
2. 填充 TODO 标记的内容
3. 补充设计决策和理由
4. 添加使用示例
5. 运行 /verify-module 校验完整性
```
## 生成后检查清单
### README.md
- [ ] 填充模块描述
- [ ] 补充特性列表
- [ ] 添加使用示例
- [ ] 确认依赖完整
### DESIGN.md
- [ ] 明确设计目标
- [ ] 记录设计决策
- [ ] 说明技术选型理由
- [ ] 列出已知限制
---
章节与文件索引
按说明文件中的顺序排列。
自动生成
README.md 骨架
DESIGN.md 骨架
支持的语言
提取的信息
文件/命令 -> scripts/doc_generator.js · README.md · requirements.txt/pyproject.toml · DESIGN.md · doc_generator.js
内容校验值 -> df953ed1b993
当前原文的自动摘译,尚未人工审校。
自动生成
运行文档生成脚本(跨平台):
README.md 骨架
自动生成的 README.md 包含: 模块名称 — 从目录名提取 描述 — 从代码文档字符串提取(如有) 特性列表 — 待填充 依赖 — 从 requirements.txt/pyproject.toml 提取
DESIGN.md 骨架
自动生成的 DESIGN.md 包含: 设计概述 — 目标与非目标模板 架构设计 — 架构图占位符 核心组件 — 从代码提取类列表 设计决策 — 决策记录表格模板
支持的语言
语言 · 分析能力 Python · 类、函数、文档字符串、依赖 Go · 目录结构、依赖 TypeScript · 目录结构、依赖 Rust · 目录结构、依赖
提取的信息
模块名称(目录名) 主要编程语言 代码文件列表 类和函数定义(Python) 文档字符串(Python)