agentleFS
Sign inStart free
354685856-sn354685856-sn/claude-code-skills/doc-gen/SKILL.md

doc-gen

Skill0 starsChanged 7 months agoMITView on GitHub

文档生成与更新 - 自动生成 API 文档并保持与代码同步

9 other projects use a version of this.

Adopted by

Most recently taken up by

Used with

Projects with it also use ascii-diagram, research-fleet and 8 more.

Other files people use alongside this one.

Files found in the same public projects as a version of this one, more often than they turn up anywhere else. Each project counts once, large collections count for less, and this file's own repository is left out.
  • SethGammonSkill

    ascii-diagram

    Generate perfectly aligned ASCII diagrams — architecture, flow, sequence, box-and-arrow. Uses a programmatic character-grid approach so alignment is guaranteed by math, not token prediction. Includes post-render verification.

    Also in 4 projects that use this

  • SethGammonSkill

    research-fleet

    Parallel research using Fleet wave mechanics. Spawns multiple scout agents, each investigating a different angle of the same question. Findings are compressed between waves. Produces a unified research brief from multiple independent perspectives.

    Also in 3 projects that use this

  • vicoa-aiSkill

    live-preview

    Start a local app in the current user project, expose it through a tunnel, and return preview details in structured Markdown. Use when the user asks for a preview URL, public URL, shareable localhost, mobile/web preview, or tunnel setup.

    Also in 4 projects that use this

  • BerryKuipersSkill

    scaffold

    Detect project stack, apply architecture patterns, wire quality gates, and scaffold features. Use when bootstrapping a project, adding a vertical slice, wiring CI/CD, adding Docker compose, or setting up quality gates.

    Also in 4 projects that use this

  • wpankSkill

    session-handoff

    WHAT: Create comprehensive handoff documents that enable fresh AI agents to seamlessly continue work with zero ambiguity. Solves long-running agent context exhaustion problem.

    Also in 4 projects that use this

  • Google CloudSkill

    triage

    Gather context on a change or bug and plan the implementation.

    Also in 4 projects that use this

  • +1 more from SethGammon

The file

Create a free account to mount
Files
SKILL.md

Documentation Generation Skill

用途

自动生成或更新 API 文档、README、代码注释等。

文档类型

1. API 文档

  • OpenAPI/Swagger 规范
  • GraphQL Schema 文档
  • RESTful API 参考

2. 代码文档

  • JSDoc/TypeDoc 注释
  • Python docstrings
  • Go doc comments

3. 项目文档

  • README.md
  • CONTRIBUTING.md
  • CHANGELOG.md
  • 架构文档

使用方法

/claude "使用 doc-gen skill 生成这个模块的 API 文档"
/claude "使用 doc-gen skill 更新 README"

文档生成原则

  1. 准确性 - 文档必须与代码一致
  2. 完整性 - 覆盖所有公开 API
  3. 示例驱动 - 包含使用示例
  4. 可搜索 - 结构清晰便于查找

输出格式

## 文档更新报告

### 生成的文档
- 文件列表

### 更新的文档
- 文件列表及变更

### 需要同步的问题
- 发现的问题列表

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

Check your setup, free