Documentation Generator

Documentation Generator is a Writing skill for Claude Code, published by telagod in code-abyss.

239 stars32 forkson telagod/code-abyssAdded 2026/09/03Repository updated 2026/07/19

agent-skillsai-agentai-assistantai-personalityblue-teamcharacter-cardclaude-codeclicodexcodex-cliconfigurationdeveloper-toolsdevopsgemini-clipersonaprompt-engineeringred-teamsecurityskills

Install in seconds

Install Documentation Generator

Copy Documentation Generator into your Claude Code skills folder. Run the command in your terminal, or review the source on GitHub before installing.

terminal

npx degit https://github.com/telagod/code-abyss/tree/main/skills/generating-docs ~/.claude/skills/generating-docs

Requires Node.js. Downloads this skill only — not the rest of the repository — into your Claude Code skills folder.

Without Node.js

git clone https://github.com/telagod/code-abyss.git

Clones the whole repository, then copy the skill’s own directory into your skills folder yourself.

In this catalog

Source file: skills/generating-docs/SKILL.md in telagod/code-abyss
Installs to: ~/.claude/skills/generating-docs
Collection: One of 25 skills cataloged from this repository
Category: Writing — 1109 skills

What Documentation Generator does

Documentation Generator creates README.md and DESIGN.md scaffolds by analyzing a module’s structure. Use it when a new module is created or when documentation is missing and needs a starter template.

Documentation Generator is cataloged under Writing on DirSkills. Documentation Generator comes from a repository tagged agent-skills, ai-agent, ai-assistant, ai-personality and blue-team.

Documentation

README

Excerpt

造典关卡 · 文档生成器

生成的是骨架，不是答案。填决策理由是人的工作，工具不能代劳。

何时使用

场景	跑	理由
新模块创建后第一时间	✅	趁记忆新鲜填决策
verifying-modules 报「缺 README/DESIGN」	✅	直接补救
重构后边界变化	⚠	看是否要重生成或手动改；不要 `--force` 覆盖已有内容
已有完整文档	❌	不要破坏人工写的内容

生成内容

README.md（自动可填部分）

字段	自动来源	待人补
模块名	目录名	是否有更好的展示名
描述	顶级 docstring（Python）	「存在理由」必须人写
特性	TODO（占位）	列 3–5 个核心能力
依赖	`requirements.txt` / `package.json` / `Cargo.toml` 等	是否有运行时假设
使用方法	TODO（占位）	5 分钟跑通示例
API 概览	公开类/函数签名	调用顺序、生命周期
目录结构	`tree` 输出	—

DESIGN.md（骨架占位）

This is the opening of the README. Read the full README on GitHub.

Frequently asked about Documentation Generator

What else does telagod publish alongside Documentation Generator?
Documentation Generator is one of 25 skills that DirSkills catalogs from telagod/code-abyss, the repository it ships in. Its siblings there include Adversarial Review Orchestration, Analyzing Changes and Analyzing Spreadsheets. Each one is a separate skill with its own page in this directory, installs the same way Documentation Generator does, and is maintained by telagod in that same repository. The rest of the collection is listed on the telagod/code-abyss page.
How does Documentation Generator compare to other Writing skills?
Documentation Generator ranks #905 by stars among the 1109 Writing skills in this catalog. The most-starred ones next to it are Article Writing, Social Media Content Calendar and Knowledge Comic Creator. DirSkills ranks by the star count of the repository each skill ships in, so that order reflects how popular those repositories are rather than any review of Documentation Generator against them. Open each page to compare what they document and how they install.