Tarvis · AI 编码工具 & 大模型比价平台
AI 技能
返回列表

Documentation Generation Skill

文档生成

Anthropic 官方文档生成 Skill,自动生成 README / API 文档 / 用户指南。

anthropics/skills8.2k610更新于 2026-06-10
概览

Anthropic 官方 skills 仓库中的文档生成 Skill,基于项目代码自动生成各类文档。

支持生成 README.md、API 文档(OpenAPI / Markdown)、用户指南、CHANGELOG 等。

支持从代码注释提取文档(JSDoc / docstring / Javadoc)。

适合开源项目维护和企业内部文档建设。

基础信息
作者
anthropics
主语言
Markdown
开源协议
MIT
Star 数
8,200
Fork 数
610
最近更新
2026-06-10
标签
Claude Code文档生成READMEAPI 文档
适配平台
claude-code
安装指南
  1. 1

    git clone https://github.com/anthropics/skills.git

  2. 2

    复制 documentation 目录到 ~/.claude/skills/

  3. 3

    运行 claude,对话中描述「为这个项目生成 README」

  4. 4

    可选:在 .claude/config.json 中配置文档风格(如 Microsoft / Google 风格)

优缺点
优点
  • 自动分析代码生成文档,省时省力
  • 支持多种文档类型
  • 从代码注释提取,保持同步
  • 适合开源与企业内部使用
缺点
  • 生成的文档需要人工润色
  • 对复杂业务逻辑描述可能不准确
  • 依赖代码注释质量
适用场景
1开源项目 README 自动生成
2API 文档维护:从代码生成 OpenAPI
3新员工入职文档:自动生成项目概览
4版本发布:自动生成 CHANGELOG
常见问题

觉得这个技能有用?
去 GitHub 给作者一个 Star,支持项目持续维护
Star on GitHub