auto-doc

Community

Auto-update README and CHANGELOG from code changes

AuthorXunzi229
Version1.0.0
Installs0

System Documentation

What problem does it solve?

在代码提交或修改后,维护文档(README.md 和 CHANGELOG.md)通常是重复且容易遗漏的工作。该 Skill 自动识别代码、配置或接口变更,并将关键信息同步到项目文档,减少人工维护负担并保证发布记录的一致性。

Core Features & Use Cases

  • 变更提取:从 git diff 或工作区修改中提取新增功能、修复或接口变动的核心要点。
  • README 同步:当配置项或对外接口变更时,自动更新 README 中的配置说明或示例。
  • CHANGELOG 记录:按照 Keep a Changelog 规范在 Unreleased 或当前版本下追加精简条目,并建议 SemVer 版本变更。
  • Use Case:开发者在完成功能并提交代码后,让该 Skill 自动在 CHANGELOG.md 添加 [Added]/[Fixed] 条目并检查 README 示例是否需更新。

Quick Start

使用本 Skill 根据 git diff 或已修改的文件自动追加简短条目到 CHANGELOG.md 的 Unreleased 区并同步 README.md 中受影响的配置或示例。

Dependency Matrix

Required Modules

None required

Components

scripts

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: auto-doc
Download link: https://github.com/Xunzi229/skills/archive/main.zip#auto-doc

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 223,000+ vetted skills library on demand.