Codegen Doc logo

Codegen Doc

CommunityPopular
xstongxue
codegen-doc

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

Overview

Publisherxstongxue
Repositorybest-skills
Skill namecodegen-doc
Stars
2.9K
Forks
201
Bundled files
4
LicenseApache-2.0
Links
  • Markdown instructions

    A SKILL.md file the model loads on demand, so it only costs tokens when a request actually matches.

  • Works with any LLM

    AI skills are plain Markdown, not provider-specific code, so this works with GPT, Claude, Gemini, Grok, or a local model.

  • 4 bundled files

    Scripts, templates, and references the model can read while it works. Files are read-only and never executed.

  • Open source

    Published by xstongxue on GitHub. Read the source before you install it.

Installation

Install the Codegen Doc AI skill in TypingMind to use it with any LLM, or drop it into another agent that reads SKILL.md.

1

Install in TypingMind

TypingMind installs a skill straight from its GitHub folder — it reads SKILL.md, bundles the resource files, and stores the result locally.

  1. Open the app and go to Plugins → Skills.
  2. Choose "Install from GitHub".
  3. Paste the skill folder URL below and confirm.
  4. Enable the skill in any chat where you want it available.
Plugins → Skills → Add skill → From GitHub URL, then paste the folder URL and press Continue.
2

Install in another agent

Any agent that reads the Agent Skills format can use this skill — copy the folder into that agent's skills directory.

Claude Code — .claude/skills
git clone --depth 1 https://github.com/xstongxue/best-skills.git /tmp/best-skills
mkdir -p .claude/skills
cp -r /tmp/best-skills/skills/codegen-doc .claude/skills/codegen-doc
Restart Claude Code after copying so it picks up the new skill.

Use it in TypingMind

Enable Codegen Doc in any TypingMind chat and the model takes it from there. Its name and description sit in the system prompt, and the moment a request matches, the model loads the full instructions itself — you never invoke it by hand, and it costs no tokens until it is actually used.

The model loads Codegen Doc on its own as soon as a request matches it.

Works with any AI model

AI skills are plain Markdown instructions rather than provider-specific code, so Codegen Doc is not tied to the model it was written for. Install it once in TypingMind and use it with GPT-5, Claude, Gemini, Grok, DeepSeek, Mistral, Llama, or a local model you run yourself — all on your own API keys.

  • Loaded only when it is needed

    The system prompt carries just the name and description. The instructions are fetched on the first matching request, so an idle skill costs nothing.

  • Switch models mid-chat

    Because the skill is instructions rather than code, changing model does not break it — the next model reads the same SKILL.md.

Skill instructions

This is the SKILL.md content the model loads. Read it before installing — a skill is instructions your model will follow.

代码生成·项目文档

本 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、文档中抽取
  • 格式遵从:用户提供格式/模板时,严格按格式组织输出

Bundled files

The model reads these on demand while the skill is loaded. They are exposed as readable files and are never executed.

Frequently asked questions

What does the Codegen Doc AI skill do?

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

Why use Codegen Doc on TypingMind?

Because you install it once and use it with any model. Codegen Doc is plain Markdown rather than provider-specific code, so the same skill runs on GPT-5, Claude, Gemini, Grok, or a local model — and you can switch model mid-chat without it breaking. TypingMind runs on your own API keys, so you pay providers directly instead of a per-seat subscription, and your skills and chats stay in your own storage.

How do I install Codegen Doc in TypingMind?

Open Plugins → Skills → Install from GitHub in TypingMind and paste https://github.com/xstongxue/best-skills/tree/main/skills/codegen-doc. TypingMind reads its SKILL.md and bundles its files and installs it as a skill you can enable per chat.

Which AI models can use Codegen Doc?

Any model you connect in TypingMind. AI skills are plain Markdown instructions rather than provider-specific code, so GPT, Claude, Gemini, Grok, and local models can all load this skill when a request matches it.

How many AI models can I use with Codegen Doc?

As many as you like. As long as a model supports skills, you can use Codegen Doc with it — GPT, Claude, Gemini, Grok, DeepSeek, Mistral, Llama and more — all on TypingMind with your own API keys.

Is the Codegen Doc AI skill free?

Yes. It is published on GitHub by xstongxue under the Apache-2.0 license. You only pay your own AI provider for the tokens you use.

What are AI skills?

An AI skill is a reusable instruction bundle that teaches an AI model how to do one specific task. It follows the open Agent Skills format: a SKILL.md file with a name and description, plus any scripts, templates or reference files the model may need. The model reads the instructions only when your request matches the skill, so an installed skill costs nothing until it is used.

How are AI skills different from plugins or MCP servers?

A plugin or MCP server gives a model new tools to call — code that runs somewhere and returns a result. An AI skill gives the model knowledge and process instead: how to approach a task, which steps to follow, what good output looks like. Skills are plain Markdown, so they need no server, no API key and no runtime, and they work with any model.

View all

Set up your own AI workspace now

Get notified about new features and future giveaways by subscribing to our newsletter 👇