Agent skill

Codegen Doc

by xstongxue in xstongxue/best-skills

基于当前项目/代码生成各类文档,支持论文章节、项目梳理、重点问题、简历项目描述四种类型。当用户提到生成论文章节、项目梳理、技术难点、简历项目描述时使用。要给新同事看的上手文档(新人文档、架构文档、代码导读、onboarding)用 project-docs。

Apache-2.0Auto-check passedDevelopment

Install Codegen Doc

skills CLI
$ npx skills add xstongxue/best-skills --skill codegen-doc -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI
$ gh skill install xstongxue/best-skills codegen-doc --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy
$ git clone --depth 1 https://github.com/xstongxue/best-skills.git skills-src && mkdir -p .claude/skills && cp -r skills-src/skills/codegen-doc .claude/skills/codegen-doc && rm -rf skills-src

Use ~/.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/

Facts

Skill name
codegen-doc
GitHub stars
3k
Token cost
~323 tokens
SKILL.md length
58 words
Files
5
Skills in repo
15
Repo updated
First seen
Licence
Apache-2.0

At a glance

基于当前项目/代码生成各类文档,支持论文章节、项目梳理、重点问题、简历项目描述四种类型。当用户提到生成论文章节、项目梳理、技术难点、简历项目描述时使用。要给新同事看的上手文档(新人文档、架构文档、代码导读、onboarding)用 project-docs。

  • Works in 3 steps: 看轮廓 —— 目录树(排除 node_modules / build /… → 看骨架 —— 入口文件、路由或接口定义、配置文件、每个顶层目录一句话职责 → 按类型补读
  • Tasks that involve Project scaffolding
  • SKILL.md covers Step 0:任务识别, 怎么读项目, 使用时机 and 通用原则
  • Instructions only: no scripts, shell commands, URLs or credentials in SKILL.md

What it does

Codegen Doc is an agent skill from xstongxue/best-skills. 基于当前项目/代码生成各类文档,支持论文章节、项目梳理、重点问题、简历项目描述四种类型。当用户提到生成论文章节、项目梳理、技术难点、简历项目描述时使用。要给新同事看的上手文档(新人文档、架构文档、代码导读、onboarding)用 project-docs。

Its SKILL.md is about 320 tokens, which your agent loads only when the skill is triggered. The skill folder holds 5 other files (for example `reference/key-issues.md`, `reference/overview.md` and `reference/resume-format.md`).

It sits in Development, covering Project scaffolding. The licence is Apache-2.0.

When your agent uses it

  • Tasks that involve Project scaffolding

Example prompts

  • “/codegen-doc”

Workflow steps

3 steps, taken from the first numbered list in SKILL.md.

  1. 看轮廓 —— 目录树(排除 node_modules / build / dist / vendor)、构建和依赖文件(package.json / pom.xml / requirements.txt / go.mod 等)、README,得出项目干什么、用什么技术栈
  2. 看骨架 —— 入口文件、路由或接口定义、配置文件、每个顶层目录一句话职责
  3. 按类型补读

What it can do on your machine

Read from SKILL.md and the folder at commit 9aa4e55. It shows what the files ask for, not the result of running them.

  • Tool permissions

    Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.

    From allowed-tools in the SKILL.md frontmatter.

  • Runs code

    No scripts in the folder and no shell commands in SKILL.md.

    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.

Context cost

Codegen Doc loads about 323 tokens when it runs. Until then it costs about 35 tokens; SKILL.md has 58 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~35
When it runs · the whole SKILL.md, loaded when a task matches
~323

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 passed

The automated check found no risky patterns in SKILL.md.

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); files beside SKILL.md are not scanned.

SKILL.md

The full file from xstongxue/best-skills at commit 9aa4e55, republished under its Apache-2.0 licence (© xstongxue). 58 words, ~323 tokens.

Download SKILL.mdSave it as .claude/skills/codegen-doc/SKILL.md (or your agent's skills folder). This skill also uses 4 other files; get the full folder from GitHub.
name
codegen-doc
description
基于当前项目/代码生成各类文档,支持论文章节、项目梳理、重点问题、简历项目描述四种类型。当用户提到生成论文章节、项目梳理、技术难点、简历项目描述时使用。要给新同事看的上手文档(新人文档、架构文档、代码导读、onboarding)用 project-docs。

代码生成·项目文档

本 Skill 指导 Agent 基于当前项目/代码仓库生成各类文档,支持四种类型:论文章节、项目梳理、重点问题、简历项目描述。

Step 0:任务识别

用户表述 / 关键词执行
论文章节、系统设计、总体设计、详细设计reference/thesis-chapter.md
项目梳理、项目文档结构、按格式梳理reference/overview.md
重点问题、技术难点、待解决问题、项目风险reference/key-issues.md
简历项目描述、项目经历、按简历格式reference/resume-format.md

不属于这四种的情况:用户要的是给新同事看、能照着上手的项目文档(新人文档、架构文档、代码导读、onboarding),用 project-docs。本 Skill 产出的是按对方指定格式写、给导师/评委/HR/领导看的东西。

怎么读项目

四种类型都要先读代码。不要试图读完所有源文件,分三步:

  1. 看轮廓 —— 目录树(排除 node_modules / build / dist / vendor)、构建和依赖文件(package.json / pom.xml / requirements.txt / go.mod 等)、README,得出项目干什么、用什么技术栈
  2. 看骨架 —— 入口文件、路由或接口定义、配置文件、每个顶层目录一句话职责
  3. 按类型补读
    • 论文章节:部署相关文件、模块之间怎么调用
    • 项目梳理:用户格式里点名要的部分(写「核心接口」就去读路由表)
    • 重点问题:TODO / FIXME、README 的 Known issues / Limitations、异常处理和兜底逻辑
    • 简历项目描述:可量化的东西(接口数、模块数、测试覆盖),只在真有依据时写

技术栈、模块名、接口名要和代码逐字一致,不要凭印象改写。

使用时机

  • 用户需要根据当前项目生成论文章节、项目梳理、重点问题清单或简历项目描述
  • 用户提到「根据当前项目」「根据代码」「按这个格式……」

通用原则

  • 不编造:未在仓库中出现的内容不写入
  • 有据可依:尽量从代码、注释、README、文档中抽取
  • 格式遵从:用户提供格式/模板时,严格按格式组织输出

© xstongxue, Apache-2.0. 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 4 other files in skills/codegen-doc of xstongxue/best-skills.

  • SKILL.md
  • reference/key-issues.md
  • reference/overview.md
  • reference/resume-format.md
  • reference/thesis-chapter.md

Open the folder on GitHubat commit 9aa4e55

Compare with similar skills

Codegen Doc 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.

Codegen Doc compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Codegen Doc this skillxstongxue/best-skills3k—~323Automated safety check: PassApache-2.0
Nx Generatenomcopter/react-mosaic4.8k7 repos~1.9kAutomated safety check: PassCustom licence
PonytailDavidObando/gsharp5658 repos~1.7kAutomated safety check: PassMIT
Run Nx Generatornrwl/nx29k2 repos~592Automated safety check: NotesMIT
Conductor Setupgemini-cli-extensions/conductor3.8k—~4.2kAutomated safety check: PassApache-2.0
Mirage VFS Adapter Authoringstrukto-ai/mirage3.7k—~2.5kAutomated safety check: PassApache-2.0

Similar skills

  • Nx Generate

    nomcopter/react-mosaic

    Generate code using nx generators. An agent skill from nomcopter/react-mosaic.

    4.8k GitHub starsUsed in 7 repos~1.9k tokens
    DevelopmentAuto-check passed
  • Ponytail

    DavidObando/gsharp

    Forces the laziest solution that actually works, simplest, shortest, most minimal.

    565 GitHub starsUsed in 8 repos~1.7k tokens
    DevelopmentAuto-check passed
  • Run Nx generators with prioritization for workspace-plugin generators.

    29k GitHub starsUsed in 2 repos~592 tokens
    DevelopmentAuto-check: notes
  • Conductor Setup

    gemini-cli-extensions/conductor

    Scaffolds the project and sets up the Conductor environment.

    3.8k GitHub stars~4.2k tokensUpdated 1 mo ago
    DevelopmentAuto-check passed
  • Builds or extends a custom Mirage virtual filesystem adapter for an API, database, object store or app data, with a working mount configuration and filesystem tests.

    3.7k GitHub stars~2.5k tokensUpdated today
    DevelopmentAuto-check passed
  • Enforces this repository's TypeScript backend module architecture under server/: feature folders, barrel exports, and where shared types and utilities belong.

    14k GitHub stars~1.2k tokensUpdated yesterday
    DevelopmentAuto-check passed

More from xstongxue/best-skills

All 15 skills in this repo
  • Create Skill

    xstongxue/best-skills

    Guides users through creating effective Agent Skills for Cursor.

    3k GitHub starsUsed in 1 repo~3.6k tokens
    Auto-check passed
  • Office File Process

    xstongxue/best-skills

    处理 Office 文档的一站式 skill:Word(.doc/.docx/.dotx)、Excel(.xls/.xlsx/.xlsm/.csv)、PowerPoint(.ppt/.pptx/.potx) 的创建、读取、编辑、提取、转换、校验。触发:『读取 word 文档』『提取 excel 内容』『看 ppt 讲了什么』、.doc 老格式打不开、生成/编辑 Word…

    3k GitHub stars~1.8k tokensUpdated 25 days ago
    Auto-check passed
  • Pptgen Drawio

    xstongxue/best-skills

    根据论文或汇报内容生成多页 Draw.io 格式 PPT,支持论文答辩与通用汇报两种模式,自动导出为 .pptx。当用户提到论文答辩 PPT、答辩幻灯片、通用 PPT、汇报 PPT、根据模板生成 PPT、drawio2pptx 时使用。

    3k GitHub stars~2.1k tokensUpdated 25 days ago
    Auto-check passed
  • Wechat Article Writer

    xstongxue/best-skills

    公众号/自媒体全流程。根据用户表述自动匹配:撰写文章、封面图、正文插图、风格提取。支持多种写作风格。当用户提到写公众号、技术博客、公众号封面、正文插图、步骤图、演示图、流程示意、分析写作风格、克隆文风、模仿爆款、提取风格时使用。详见 reference 目录。

    3k GitHub stars~2k tokensUpdated 25 days ago
    Auto-check: notes
  • Drawio Diagram

    xstongxue/best-skills

    为深度学习模型、网络架构、算法流程等生成标准 Draw.io (.drawio) 格式的可视化图表;支持从零生成与风格迁移两种模式。从零生成:模型架构图、流程图、感受野示意图等;风格迁移:参考图 + 内容描述/项目 → 按参考图风格生成新图。确保 XML 格式正确,可直接在 Draw.io 中打开编辑。

    3k GitHub stars~487 tokensUpdated 25 days ago
    Auto-check passed
  • Project Docs

    xstongxue/best-skills

    对任意代码项目生成一套面向新人的循序渐进文档集,输出到 docs/ 目录。含架构、设计思想、语言特性、代码导读、运行时模型、构建、对接、调试、设计规范共 9 篇,支持全部生成 / 只写几篇 / 更新已有文档。当用户提到"生成项目文档"、"新人文档"、"上手文档"、"架构文档"、"代码导读"、"项目理解"、"深入理解项目"、"onboarding…

    3k GitHub stars~720 tokensUpdated 25 days ago
    Auto-check passed

Categories

Questions about Codegen Doc

What does Codegen Doc do?

基于当前项目/代码生成各类文档,支持论文章节、项目梳理、重点问题、简历项目描述四种类型。当用户提到生成论文章节、项目梳理、技术难点、简历项目描述时使用。要给新同事看的上手文档(新人文档、架构文档、代码导读、onboarding)用 project-docs。. Codegen Doc is an agent skill from xstongxue/best-skills.

When should I use Codegen Doc?

Codegen Doc fits situations like: tasks that involve Project scaffolding.

How do I install Codegen Doc in Claude Code?

Run `npx skills add xstongxue/best-skills --skill codegen-doc -a claude-code`. Or copy the skill folder (skills/codegen-doc in xstongxue/best-skills) into .claude/skills/codegen-doc in your project. Claude Code loads it when a task matches its description.

How do I install Codegen Doc in Codex?

Run `npx skills add xstongxue/best-skills --skill codegen-doc -a codex`. Or copy the skill folder (skills/codegen-doc in xstongxue/best-skills) into .agents/skills/codegen-doc in your project. Codex loads it when a task matches its description.

Can I use Codegen Doc 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 xstongxue/best-skills --skill codegen-doc -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/codegen-doc, .gemini/skills/codegen-doc, .github/skills/codegen-doc and .opencode/skills/codegen-doc in your project.

What does Codegen Doc need to run?

SKILL.md names no scripts, command-line tools or credentials: Codegen Doc is instructions for the agent only.

Does Codegen Doc 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 Codegen Doc safe to install?

Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.

What licence does Codegen Doc use?

Codegen Doc is published under the Apache-2.0 licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does Codegen Doc use?

About 323 tokens (SKILL.md is roughly 1.3k 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 Codegen Doc?

Skills that share tags, products or a category with Codegen Doc: Nx Generate (nomcopter/react-mosaic, 4.8k stars), Ponytail (DavidObando/gsharp, 565 stars), Run Nx Generator (nrwl/nx, 29k stars) and Conductor Setup (gemini-cli-extensions/conductor, 3.8k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Codegen Doc?

xstongxue (a GitHub user) maintains it in xstongxue/best-skills, which has 2,951 GitHub stars. The repository holds 15 skills in this directory. The repository was last updated on September 13, 2026.

Source: xstongxue/best-skills on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.