README and DESIGN Generator
fengshao1227/ccg-workflow
Generates README.md and DESIGN.md skeletons for a module by scanning its structure with a Node script, then lists what to fill in by hand.
Generates README.md and DESIGN.md skeletons for a module from its directory structure and code, leaving the decision reasoning for a person to fill in.
SKILL.md written in Chinese; this summary is our English description.
Install Module Docs Generator
$ npx skills add telagod/code-abyss --skill generating-docs -a claude-codeProject install by default; add -g for ~/.claude/skills/.
$ gh skill install telagod/code-abyss generating-docs --agent claude-codeProject scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).
$ git clone --depth 1 https://github.com/telagod/code-abyss.git skills-src && mkdir -p .claude/skills && cp -r skills-src/skills/generating-docs .claude/skills/generating-docs && rm -rf skills-srcUse ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.
Claude Code skills documentation · loads skills from .claude/skills/
Install the "generating-docs" agent skill from https://github.com/telagod/code-abyss/tree/main/skills/generating-docs into .claude/skills/generating-docs/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "generating-docs", then confirm the skill loads.Claude Code copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$skill-installer install https://github.com/telagod/code-abyss/tree/main/skills/generating-docsType this inside Codex. $skill-installer <name> installs a curated skill from openai/skills. The installer writes to $CODEX_HOME/skills (default ~/.codex/skills). Restart Codex if the skill does not show up.
$ npx skills add telagod/code-abyss --skill generating-docs -a codexProject install goes to .agents/skills/; add -g for ~/.codex/skills/.
$ gh skill install telagod/code-abyss generating-docs --agent codexProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/telagod/code-abyss.git skills-src && mkdir -p .agents/skills && cp -r skills-src/skills/generating-docs .agents/skills/generating-docs && rm -rf skills-srcUse ~/.agents/skills/ instead of .agents/skills for a personal install.
Codex skills documentation · loads skills from .agents/skills/
Install the "generating-docs" agent skill from https://github.com/telagod/code-abyss/tree/main/skills/generating-docs into .agents/skills/generating-docs/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "generating-docs", then confirm the skill loads.Codex copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ npx skills add telagod/code-abyss --skill generating-docs -a cursorProject install goes to .agents/skills/; add -g for ~/.cursor/skills/.
$ gh skill install telagod/code-abyss generating-docs --agent cursorProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/telagod/code-abyss.git skills-src && mkdir -p .cursor/skills && cp -r skills-src/skills/generating-docs .cursor/skills/generating-docs && rm -rf skills-srcUse ~/.cursor/skills/ instead of .cursor/skills for a personal install.
Cursor skills documentation · loads skills from .cursor/skills/, .agents/skills/, .claude/skills/, .codex/skills/
Install the "generating-docs" agent skill from https://github.com/telagod/code-abyss/tree/main/skills/generating-docs into .cursor/skills/generating-docs/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "generating-docs", then confirm the skill loads.Cursor copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ gemini skills install https://github.com/telagod/code-abyss.git --path skills/generating-docs--scope user (default) or --scope workspace; --path is the subfolder of the repo that holds the skill; --consent skips the security confirmation prompt.
$ npx skills add telagod/code-abyss --skill generating-docs -a gemini-cliProject install goes to .agents/skills/; add -g for ~/.gemini/skills/.
$ gh skill install telagod/code-abyss generating-docs --agent gemini-cliProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/telagod/code-abyss.git skills-src && mkdir -p .gemini/skills && cp -r skills-src/skills/generating-docs .gemini/skills/generating-docs && rm -rf skills-srcUse ~/.gemini/skills/ instead of .gemini/skills for a personal install, then run /skills reload.
Gemini CLI skills documentation · loads skills from .gemini/skills/, .agents/skills/
Install the "generating-docs" agent skill from https://github.com/telagod/code-abyss/tree/main/skills/generating-docs into .gemini/skills/generating-docs/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "generating-docs", then confirm the skill loads.Gemini CLI copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ gh skill install telagod/code-abyss generating-docsInstalls for Copilot at project scope by default; add --scope user for a personal install. Preview a skill first with gh skill preview. Needs GitHub CLI 2.90.0 or later (public preview).
$ npx skills add telagod/code-abyss --skill generating-docs -a github-copilotProject install goes to .agents/skills/; add -g for ~/.copilot/skills/.
$ git clone --depth 1 https://github.com/telagod/code-abyss.git skills-src && mkdir -p .github/skills && cp -r skills-src/skills/generating-docs .github/skills/generating-docs && rm -rf skills-srcUse ~/.copilot/skills/ instead of .github/skills for a personal install. Commit .github/skills so cloud agent and code review can use it.
GitHub Copilot skills documentation · loads skills from .github/skills/, .claude/skills/, .agents/skills/
Install the "generating-docs" agent skill from https://github.com/telagod/code-abyss/tree/main/skills/generating-docs into .github/skills/generating-docs/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "generating-docs", then confirm the skill loads.GitHub Copilot copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ npx skills add telagod/code-abyss --skill generating-docs -a opencodeOpenCode documents no install command of its own. Project install goes to .agents/skills/; add -g for ~/.config/opencode/skills/.
$ gh skill install telagod/code-abyss generating-docs --agent opencodeProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/telagod/code-abyss.git skills-src && mkdir -p .opencode/skills && cp -r skills-src/skills/generating-docs .opencode/skills/generating-docs && rm -rf skills-srcUse ~/.config/opencode/skills/ instead of .opencode/skills for a personal install.
OpenCode skills documentation · loads skills from .opencode/skills/, .claude/skills/, .agents/skills/
Install the "generating-docs" agent skill from https://github.com/telagod/code-abyss/tree/main/skills/generating-docs into .opencode/skills/generating-docs/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "generating-docs", then confirm the skill loads.OpenCode copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
Facts
- Skill name
generating-docs- GitHub stars
- 244
- Token cost
- ~507 tokens
- SKILL.md length
- 126 words
- Files
- 3 (incl. scripts)
- Skills in repo
- 38
- Repo updated
- First seen
- Licence
- MIT
At a glance
Generates README.md and DESIGN.md skeletons for a module from its directory structure and code, leaving the decision reasoning for a person to fill in.
- Scaffolding README.md and DESIGN.md right after creating a module
- SKILL.md covers 何时使用, 生成内容, 语言支持 and 流程, plus 4 more sections
- Runs JavaScript scripts from its folder; calls node
- Fixing a missing README or DESIGN report from a module check
What it does
A Node script, doc_generator.js, scans a module and writes README.md and DESIGN.md scaffolds. For the README it fills in the module name from the directory, a description from the top-level docstring in Python, dependencies from files such as requirements.txt, package.json and Cargo.toml, public API signatures and a tree of the folder. Features and usage are left as placeholders. DESIGN.md gets placeholder sections for goals and non-goals, architecture, decisions, technology choices, trade-offs and security considerations.
The skill stresses that the output is a skeleton and that writing the reasoning behind decisions is a human job. Python gets the deepest extraction, Go, TypeScript and Rust get directory structure and dependencies, and other languages get a basic layout. Run it right after creating a module, or when a verifying-modules check reports a missing README or DESIGN. Avoid --force over hand-written content, and do not generate in CI, where the --json mode is meant for checks only.
When your agent uses it
- Scaffolding README.md and DESIGN.md right after creating a module
- Fixing a missing README or DESIGN report from a module check
- Generating a documentation skeleton for a Python package
Example prompts
- “Generate README and DESIGN skeletons for the src/payments module.”
- “The module check says DESIGN.md is missing, so create a starting skeleton for src/auth.”
- “Run the doc generator in JSON mode on src/billing without overwriting anything.”
Requirements
- Node.js 18 or newer
- Compatibility (from SKILL.md): node>=18
- Pre-approved tools (allowed-tools): Bash, Read, Write, Glob
What it can do on your machine
Read from SKILL.md and the folder at commit 2544577. It shows what the files ask for, not the result of running them.
Tool permissions
Pre-approves these tools, so the agent can use them without asking each time:
BashReadWriteGlob
From allowed-tools in the SKILL.md frontmatter.
Runs code
Ships 1 file in scripts/ (JavaScript), which the agent can run.
Shell commands in SKILL.md call:
node
From the folder's file list and the shell code blocks in SKILL.md.
Network
No URLs in SKILL.md.
From URLs in SKILL.md, links to its own repository left out.
Credentials
Names no API keys, tokens, secrets or passwords.
From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.
Compatibility
node>=18
From compatibility in the SKILL.md frontmatter.
Context cost
Module Docs Generator loads about 507 tokens when it runs. Until then it costs about 48 tokens; SKILL.md has 126 words of instructions outside code blocks.
Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.
Safety
Auto-check: notes
The automated check noted patterns worth knowing about, such as sudo or a known installer.
- NotePre-approves every shell command (allowed-tools: Bash)SKILL.md
allowed-tools: Bash, Read, Write, Glob
Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); the scripts in this folder are not scanned.
SKILL.md
The full file from telagod/code-abyss at commit 2544577, republished under its MIT licence (© telagod). 126 words, ~507 tokens.
Download SKILL.mdSave it as
.claude/skills/generating-docs/SKILL.md (or your agent's skills folder). This skill also uses 2 other files; get the full folder from GitHub.- name
- generating-docs
- description
- Generates README.md and DESIGN.md scaffolds by analyzing module structure. Use when creating documentation templates for new modules. Automatically triggered at module creation.
- allowed-tools
- Bash, Read, Write, Glob
- compatibility
- node>=18
- user-invocable
- false
- argument-hint
- <模块路径> [--force]
造典关卡 · 文档生成器
生成的是骨架，不是答案。填决策理由是人的工作，工具不能代劳。
何时使用
| 场景 | 跑 | 理由 |
|---|---|---|
| 新模块创建后第一时间 | ✅ | 趁记忆新鲜填决策 |
| 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 校验完整性
↓
通过则提交何时不要 --force
- 目标文件已有人工内容 ——
--force会无差别覆盖。先 diff 旧版，手动合并。 - CI 环境 —— 生成应在开发机做，CI 只校验，不生成。
与其他 skill 联动
- 跑完后 → 必跑 verifying-modules
- 大模块 → 拆分前先 designing-architectures 想清楚边界
使用
node scripts/doc_generator.js <模块路径>
node scripts/doc_generator.js <模块路径> --force # 强制覆盖（慎用）
node scripts/doc_generator.js <模块路径> --json # CI 用收口
工具给骨架，TODO 不补完不算交付。生成后 5 分钟内人工填决策；超过 1 天会忘原因，文档质量陡降。
© telagod, MIT. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file
Files
SKILL.md and 2 other files (scripts) in skills/generating-docs of telagod/code-abyss.
- SKILL.md
- agents/openai.yaml
- scripts/doc_generator.js
Open the folder on GitHubat commit 2544577
Compare with similar skills
Module Docs Generator next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.
| Skill | Stars | Used in | Tokens | Auto-check | Licence | Repo updated |
|---|---|---|---|---|---|---|
| Module Docs Generator this skilltelagod/code-abyss | 244 | — | ~507 | Automated safety check: Notes | MIT | |
| README and DESIGN Generatorfengshao1227/ccg-workflow | 5.9k | — | ~410 | Automated safety check: Notes | MIT | |
| Ok Script Codegenbaoxin1100/ok-kes | 101 | — | ~2k | Automated safety check: Pass | None | |
| Swarmauri Add Community Standaloneswarmauri/swarmauri-sdk | 104 | — | ~387 | Automated safety check: Pass | Apache-2.0 | |
| Swarmauri Add Experimental Standaloneswarmauri/swarmauri-sdk | 104 | — | ~457 | Automated safety check: Pass | Apache-2.0 | |
| Swarmauri Add Plugin Packageswarmauri/swarmauri-sdk | 104 | — | ~435 | Automated safety check: Pass | Apache-2.0 |
Similar skills
Ok Script Codegen
baoxin1100/ok-kes
Generate Python automation code for ok-script task run methods from user descriptions and optional screenshots.
Swarmauri Add Community Standalone
swarmauri/swarmauri-sdk
Add a second-class standalone Swarmauri package under pkgs/community.
Swarmauri Add Experimental Standalone
swarmauri/swarmauri-sdk
Add an experimental standalone Swarmauri package under pkgs/experimental.
Swarmauri Add Plugin Package
swarmauri/swarmauri-sdk
Add a Swarmauri plugin package under pkgs/plugins. An agent skill from swarmauri/swarmauri-sdk.
Research Init
brycewang-stanford/Auto-Empirical-Research-Skills
Scaffold a new research project with full reproducibility infrastructure in R and/or Python.
More from telagod/code-abyss
All 38 skills in this repoSecurity Gate Scanner
telagod/code-abyss
Scans code with a bundled Node scanner for injection, secret leaks and other dangerous patterns, and requires documented decisions for accepted risks.
Persona Voice Card Builder
telagod/code-abyss
Distills a recurring agent voice from conversations into a restricted Persona Voice Card, validates it for schema, safety and distinctness, and prepares it for community submission.
Skill Cultivation Funnel
telagod/code-abyss
Distills repeated workflows into new skills, improves existing ones and promotes them through local, project and community tiers after a default-deny safety scan.
DOCX Processing Toolkit
telagod/code-abyss
Routes Word document tasks to the right tool: pandoc for text, raw OOXML for structure and comments, docx-js for new files, and a mandatory redlining flow for edits to others' documents.
PDF Processing Toolkit
telagod/code-abyss
Picks the right Python library or CLI tool for a PDF task, text and table extraction, merging, splitting, OCR, watermarking or form filling, and points to a matching recipe.
Code Change Analysis Gate
telagod/code-abyss
Checks what a code change touched, how far its impact reaches and whether design docs, tests and README files kept up, before commit or in review.
Related
Works with
Categories
Questions about Module Docs Generator
What does Module Docs Generator do?
Generates README.md and DESIGN.md skeletons for a module from its directory structure and code, leaving the decision reasoning for a person to fill in. md scaffolds.toml, public API signatures and a tree of the folder.
When should I use Module Docs Generator?
Module Docs Generator fits situations like: scaffolding README.md and DESIGN.md right after creating a module; fixing a missing README or DESIGN report from a module check; generating a documentation skeleton for a Python package.
How do I install Module Docs Generator in Claude Code?
Run `npx skills add telagod/code-abyss --skill generating-docs -a claude-code`. Or copy the skill folder (skills/generating-docs in telagod/code-abyss) into .claude/skills/generating-docs in your project. Claude Code loads it when a task matches its description.
How do I install Module Docs Generator in Codex?
Run `npx skills add telagod/code-abyss --skill generating-docs -a codex`. Or copy the skill folder (skills/generating-docs in telagod/code-abyss) into .agents/skills/generating-docs in your project. Codex loads it when a task matches its description.
Can I use Module Docs Generator in Cursor, Gemini CLI or GitHub Copilot?
Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add telagod/code-abyss --skill generating-docs -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/generating-docs, .gemini/skills/generating-docs, .github/skills/generating-docs and .opencode/skills/generating-docs in your project.
What does Module Docs Generator need to run?
Going by SKILL.md and its folder, Module Docs Generator needs JavaScript for the scripts in its folder and the command-line tools its instructions call (node). Our summary lists: Node.js 18 or newer. Its frontmatter pre-approves these tools: Bash, Read, Write, Glob. Compatibility (from SKILL.md): node>=18.
Does Module Docs Generator access the network?
SKILL.md contains no URLs. Any network use would come from the scripts or tools the agent runs. This is read from the text; nothing was executed.
Is Module Docs Generator safe to install?
Our automated static check of SKILL.md found notes only (pre-approves every shell command (allowed-tools: bash)), nothing it rates as a warning. It is not a guarantee. The check reads SKILL.md only: the scripts in the folder are not scanned, so read them before running anything.
What licence does Module Docs Generator use?
Module Docs Generator is published under the MIT licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.
How many tokens does Module Docs Generator use?
About 507 tokens (SKILL.md is roughly 2k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.
What are the alternatives to Module Docs Generator?
Skills that share tags, products or a category with Module Docs Generator: README and DESIGN Generator (fengshao1227/ccg-workflow, 5.9k stars), Ok Script Codegen (baoxin1100/ok-kes, 101 stars), Swarmauri Add Community Standalone (swarmauri/swarmauri-sdk, 104 stars) and Swarmauri Add Experimental Standalone (swarmauri/swarmauri-sdk, 104 stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.
Who maintains Module Docs Generator?
telagod (a GitHub user) maintains it in telagod/code-abyss, which has 244 GitHub stars. The repository holds 38 skills in this directory. The repository was last updated on July 19, 2026.
Source: telagod/code-abyss on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.