
Generating Docs
This generates README and DESIGN scaffolds for new modules by analyzing directory structure, dependencies, and code signatures. It's automatic, not user-invoked, so it runs right after module creation to give you templates while decisions are fresh. The Python support is strongest (pulls docstrings, class signatures), while other languages get directory trees and dependency lists. The key insight here is brutally honest: it fills the easy parts like module names and file lists, but leaves TODO placeholders for everything that matters, like why you made specific design choices or what you deliberately chose not to build. The source is clear that leaving those TODOs unfilled past a day means you'll forget the reasoning and documentation quality tanks. Supports a force flag but warns against using it if humans have already written content.
- GitHub stars
- 224
- last updated
- Jun 10, 2026
Install
$ npx -y skills add telagod/code-abyss --skill generating-docs --agent claude-codeInstalls into .claude/skills of the current project.
Files
造典关卡 · 文档生成器
生成的是骨架,不是答案。填决策理由是人的工作,工具不能代劳。
何时使用
| 场景 | 跑 | 理由 |
|---|---|---|
| 新模块创建后第一时间 | ✅ | 趁记忆新鲜填决策 |
| verifying-modules 报「缺 README/DESIGN」 | ✅ | 直接补救 |
| 重构后边界变化 | ⚠ | 看是否要重生成或手动改;不要 --force 覆盖已有内容 |
| 已有完整文档 | ❌ | 不要破坏人工写的内容 |
生成内容
README.md(自动可填部分)
| 字段 | 自动来源 | 待人补 |
|---|---|---|
| 模块名 | 目录名 | 是否有更好的展示名 |
| 描述 | 顶级 docstring(Python) | 「存在理由」必须人写 |
| 特性 | TODO(占位) | 列 3–5 个核心能力 |
| 依赖 | requirements.txt / package.json / Cargo.toml 等 | 是否有运行时假设 |
| 使用方法 | TODO(占位) | 5 分钟跑通示例 |
| API 概览 | 公开类/函数签名 | 调用顺序、生命周期 |
| 目录结构 | tree 输出 | — |
DESIGN.md(骨架占位)
| 字段 | 自动 | 待人补(最重要) |
|---|---|---|
| 设计目标 / 非目标 | TODO | 核心决策驱动力 |
| 架构 | TODO | 含一张图最好 |
| 核心组件 | 公开类/函数列表 | 各组件的协作关系 |
| 决策表 | TODO | 方案对比 + 选择理由 |
| 技术选型 | 依赖列表 | 选 X 不选 Y 的理由 |
| 权衡 | TODO | 牺牲了什么 |
| 安全考量 | TODO | 信任边界、威胁模型 |
语言支持
| 语言 | 提取深度 |
|---|---|
| Python | 类、函数、docstring、依赖(最完整) |
| Go / TypeScript / Rust | 目录结构 + 依赖 |
| 其他 | 基础目录结构 |
流程
doc_generator.js 生成骨架
↓
人工填 TODO(决策理由、使用示例、非目标)
↓
verify-module 校验完整性
↓
通过则提交
Sponsors
Details
- Repository
- github.com/telagod/code-abyss
- Categories
- Documentation, Design & UI/UX
- License
- MIT
- First seen
- Jun 11, 2026
More from telagod/code-abyss
All 30- Indexing Code
- Operating Kicad Eda
- Orchestrating Adversarial Reviews
- Processing Docx
- Processing Pdfs
- Provisioning Infrastructure
- Reducing Aigc Detection
- Securing Cloud And Supply Chain
- Securing Systems
- Shipping Changes
- Verifying Modules
- Analyzing Changes
- Analyzing Security
- Analyzing Spreadsheets
- Applying Ui Design System
- Architecting Security
- Automating Devops
- Building Agent Systems
- Checking Code Quality
- Creating Presentations
- Cultivating Personas
- Cultivating Skills
- Defending Applications
- Designing Architectures