Stats
Actions
Tags
From code-abyss
Generates README.md and DESIGN.md scaffolds by analyzing module structure (Python docstrings, deps, class signatures). Use for new modules or when verifying-modules reports missing docs.
How this skill is triggered — by the user, by Claude, or both
Slash command
/code-abyss:generating-docs <模块路径> [--force]<模块路径> [--force]This skill is limited to the following tools:
The summary Claude sees in its skill listing — used to decide when to auto-load this skill
> 生成的是骨架，不是答案。**填决策理由是人的工作，工具不能代劳。**
生成的是骨架，不是答案。填决策理由是人的工作，工具不能代劳。
| 场景 | 跑 | 理由 |
|---|---|---|
| 新模块创建后第一时间 | ✅ | 趁记忆新鲜填决策 |
| verifying-modules 报「缺 README/DESIGN」 | ✅ | 直接补救 |
| 重构后边界变化 | ⚠ | 看是否要重生成或手动改；不要 --force 覆盖已有内容 |
| 已有完整文档 | ❌ | 不要破坏人工写的内容 |
| 字段 | 自动来源 | 待人补 |
|---|---|---|
| 模块名 | 目录名 | 是否有更好的展示名 |
| 描述 | 顶级 docstring（Python） | 「存在理由」必须人写 |
| 特性 | TODO（占位） | 列 3–5 个核心能力 |
| 依赖 | requirements.txt / package.json / Cargo.toml 等 | 是否有运行时假设 |
| 使用方法 | TODO（占位） | 5 分钟跑通示例 |
| API 概览 | 公开类/函数签名 | 调用顺序、生命周期 |
| 目录结构 | tree 输出 | — |
| 字段 | 自动 | 待人补（最重要） |
|---|---|---|
| 设计目标 / 非目标 | TODO | 核心决策驱动力 |
| 架构 | TODO | 含一张图最好 |
| 核心组件 | 公开类/函数列表 | 各组件的协作关系 |
| 决策表 | TODO | 方案对比 + 选择理由 |
| 技术选型 | 依赖列表 | 选 X 不选 Y 的理由 |
| 权衡 | TODO | 牺牲了什么 |
| 安全考量 | TODO | 信任边界、威胁模型 |
| 语言 | 提取深度 |
|---|---|
| Python | 类、函数、docstring、依赖（最完整） |
| Go / TypeScript / Rust | 目录结构 + 依赖 |
| 其他 | 基础目录结构 |
doc_generator.js 生成骨架
↓
人工填 TODO（决策理由、使用示例、非目标）
↓
verify-module 校验完整性
↓
通过则提交
--force--force 会无差别覆盖。先 diff 旧版，手动合并。node scripts/doc_generator.js <模块路径>
node scripts/doc_generator.js <模块路径> --force # 强制覆盖（慎用）
node scripts/doc_generator.js <模块路径> --json # CI 用
工具给骨架，TODO 不补完不算交付。生成后 5 分钟内人工填决策；超过 1 天会忘原因，文档质量陡降。
npx claudepluginhub telagod/code-abyss --plugin code-abyssScaffolds project documentation (README, ARCHITECTURE, API, CODE_COMMENTS) from templates with placeholders and standards. Use for bootstrapping docs in new or under-documented codebases.
Scaffolds starter documentation (README, ARCHITECTURE, API, CODE_COMMENTS) from templates with placeholders and standards. For new or under-documented codebases.
Generates systematic documentation for code files or modules via file-by-file analysis, progress tracking, and completeness checks using structured templates. Use for API docs, READMEs, or reference guides.