telagod avatar

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-code

Installs 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
1thinkinaixyz avatardoc-coauthoringthinkinaixyz/deepchatGuide users through a structured workflow for co-authoring documentation. Use when user wants to write documentation, proposals, technical specs, decision docs,0skills.sh installs
2tldraw avatarwrite-docstldraw/tldrawWriting SDK documentation for tldraw. Use when creating new documentation articles, updating existing docs, or when documentation writing guidance is needed. Ap0skills.sh installs
3google avataradk-eval-guidegoogle/adk-docsMUST READ before running any ADK evaluation. ADK evaluation methodology — eval metrics, evalset schema, LLM-as-judge, tool trajectory scoring, and common failur2.6Kskills.sh installs
4google avataradk-observability-guidegoogle/adk-docsMUST READ before setting up observability for ADK agents or when analyzing production traffic, debugging agent behavior, or improving agent performance. ADK obs2.6Kskills.sh installs
5xixu-me avatarreadme-i18nxixu-me/skillsUse when the user wants to translate a repository README, make a repo multilingual, localize docs, add a language switcher, internationalize the README, or upda519.9Kskills.sh installs
6larksuite avatarlark-doclarksuite/cli飞书云文档(Docx / Wiki 文档):读取和编辑飞书文档内容。当用户给出文档 URL 或 token,或需要查看、创建、编辑文档、插入或下载文档图片附件时使用。文档中嵌入的电子表格、多维表格、画板,先用本 skill 提取 token 再切到对应 skill。当用户给出 doubao.com 的 /docx/ 或490.7Kskills.sh installs