README Updater Skill

Keep your README current with project changes.

让你的README随项目变更保持更新。

When I Activate

激活场景

✅ New features added
✅ Project structure changes
✅ Dependencies added/removed
✅ Setup instructions change
✅ User mentions README or documentation
✅ Configuration files modified

✅ 新增功能
✅ 项目结构变更
✅ 依赖项添加/移除
✅ 安装说明变更
✅ 用户提及README或文档
✅ 配置文件修改

What I Update

我会更新的内容

README Sections

README章节

Installation:

New dependencies
Setup steps
Prerequisites
Environment variables

Features:

New capabilities
Functionality changes
Feature deprecation

Usage:

API changes
New examples
Updated screenshots

Configuration:

New options
Environment variables
Config file changes

安装：

新依赖项
安装步骤
前置要求
环境变量

功能：

新功能
功能变更
功能弃用

使用方法：

API变更
新示例
更新截图

配置：

新选项
环境变量
配置文件变更

Examples

示例

New Feature Addition

新增功能

bash

undefined

bash

undefined

You add authentication:

git diff

+ auth.service.ts

+ login.component.tsx

+ JWT middleware

I suggest README update:

Features

✨ User authentication with JWT # NEW
🔐 Role-based access control # NEW
User management
Dashboard

undefined

✨ User authentication with JWT # NEW
🔐 Role-based access control # NEW
User management
Dashboard

undefined

New Dependency

新增依赖项

bash

undefined

bash

undefined

You add: npm install stripe

I suggest:

Installation

bash

npm install
npm install stripe  # Added for payment processing

bash

npm install
npm install stripe  # Added for payment processing

Environment Variables

bash

STRIPE_SECRET_KEY=your_stripe_key  # Required for payments

undefined

bash

STRIPE_SECRET_KEY=your_stripe_key  # Required for payments

undefined

Setup Instructions

安装说明更新

bash

undefined

bash

undefined

You modify docker-compose.yml

I update README:

Development Setup

bash

undefined

bash

undefined

1. Clone repository

git clone [url]

2. Install dependencies

npm install

3. Start services (UPDATED)

docker-compose up -d # Now includes Redis cache

4. Run migrations

npm run migrate

undefined

npm run migrate

undefined

Detection Logic

检测逻辑

Change Analysis

变更分析

I detect these changes automatically:

package.json → Update dependencies section
New routes → Update API documentation
.env.example → Update environment variables
docker-compose.yml → Update setup instructions
New features → Update features list

我会自动检测以下变更：

package.json → 更新依赖项章节
新路由 → 更新API文档
.env.example → 更新环境变量
docker-compose.yml → 更新安装说明
新功能 → 更新功能列表

Section Mapping

章节映射

yaml

Code Change → README Section:
  - New API endpoint → Usage / API Reference
  - New dependency → Installation
  - New env var → Configuration
  - New feature → Features list
  - Architecture change → Architecture section

yaml

Code Change → README Section:
  - New API endpoint → Usage / API Reference
  - New dependency → Installation
  - New env var → Configuration
  - New feature → Features list
  - Architecture change → Architecture section

Intelligent Updates

智能更新

Keep Structure

保留原有结构

I maintain your README structure:

Preserve emoji style
Keep formatting consistent
Maintain tone and voice
Respect existing organization

我会维护你的README结构：

保留表情符号风格
保持格式一致
维持原有语气和风格
尊重现有章节组织

Add Missing Sections

补充缺失章节

markdown

undefined

markdown

undefined

Suggested additions:

Prerequisites

Node.js 18+
Docker (for development)
PostgreSQL 14+

Node.js 18+
Docker (for development)
PostgreSQL 14+

Environment Variables

bash

DATABASE_URL=postgresql://localhost/mydb
API_KEY=your_api_key

bash

DATABASE_URL=postgresql://localhost/mydb
API_KEY=your_api_key

Testing

bash

npm test

undefined

bash

npm test

undefined

Update Examples

更新示例

markdown

undefined

markdown

undefined

Before:

javascript

const result = api.getUsers();

javascript

const result = api.getUsers();

After (API changed):

javascript

const result = await api.getUsers({ page: 1, limit: 10 });

undefined

javascript

const result = await api.getUsers({ page: 1, limit: 10 });

undefined

Version Compatibility

版本兼容性

I track version-specific documentation:

markdown

undefined

我会追踪版本相关的文档：

markdown

undefined

Requirements

Node.js 18+ (updated from 16+)
TypeScript 5.0+ (new requirement)
React 18+ (unchanged)

undefined

Node.js 18+ (updated from 16+)
TypeScript 5.0+ (new requirement)
React 18+ (unchanged)

undefined

Changelog Integration

变更日志集成

I can sync with CHANGELOG.md:

markdown

undefined

我可以与CHANGELOG.md同步：

markdown

undefined

Recent Changes

See CHANGELOG.md for detailed version history.

Latest (v2.1.0)

✨ Added user authentication
🔧 Fixed memory leak in data processing
📝 Updated API documentation

undefined

✨ Added user authentication
🔧 Fixed memory leak in data processing
📝 Updated API documentation

undefined

Screenshot Management

截图管理

markdown

undefined

markdown

undefined

I suggest when UI changes:

Screenshots

Updated: 2025-10-24 - New authentication panel

New feature - user profile management

undefined

Updated: 2025-10-24 - New authentication panel

New feature - user profile management

undefined

Relationship with @docs-writer

与@docs-writer的关系

Me (Skill): Keep README current with code changes @docs-writer (Sub-Agent): Comprehensive documentation strategy

我（Skill）： 随代码变更保持README更新 @docs-writer（子Agent）： 提供全面文档策略

Workflow

工作流

I detect changes
I suggest README updates
For full docs → Invoke @docs-writer sub-agent
Sub-agent creates complete documentation

我检测变更
我建议更新README
如需完整文档 → 调用**@docs-writer**子Agent
子Agent创建完整文档

Sandboxing Compatibility

沙箱兼容性

Works without sandboxing: ✅ Yes Works with sandboxing: ✅ Yes

Filesystem: Writes to README.md
Network: None required
Configuration: None required

无需沙箱即可运行： ✅ 是 支持沙箱运行： ✅ 是

文件系统：写入README.md
网络：无需网络
配置：无需额外配置

Best Practices

最佳实践

Keep it current - Update README with every feature
Be specific - Include version numbers, prerequisites
Add examples - Show actual usage, not just API
Include troubleshooting - Common issues and solutions
Badge status - Keep build/coverage badges current

保持更新 - 每新增一个功能就更新README
内容具体 - 包含版本号、前置要求
添加示例 - 展示实际用法，而非仅API说明
包含故障排除 - 常见问题及解决方案
徽章状态 - 保持构建/覆盖率徽章更新

README Templates

README模板

Basic Structure

基础结构

markdown

undefined

markdown

undefined

Project Name

Brief description

Features

Feature 1
Feature 2

Feature 1
Feature 2

Installation

bash

npm install

bash

npm install

Usage

javascript

// Example

javascript

// Example

Configuration

Environment variables needed

Contributing

How to contribute

License

MIT

undefined

MIT

undefined

Comprehensive Structure

完整结构

markdown

undefined

markdown

undefined

Project Name

Tagline

[Badges]

Tagline

[Badges]

Integration

集成

With /docs-gen Command

与/docs-gen命令集成

bash

/docs-gen --format markdown

bash

/docs-gen --format markdown

Generates:

1. README.md (via me)

2. Full documentation site (via @docs-writer)

3. API reference (via api-documenter)

undefined

undefined

With CI/CD

与CI/CD集成

yaml

undefined

yaml

undefined

.github/workflows/docs.yml

name: Update README run: |
Skill suggests updates based on changes

Review and commit

undefined

name: Update README run: |
Skill suggests updates based on changes

Review and commit

undefined

Customization

自定义

Add company-specific README standards:

bash

cp -r ~/.claude/skills/documentation/readme-updater \
      ~/.claude/skills/documentation/company-readme-updater

添加公司专属的README标准：

bash

cp -r ~/.claude/skills/documentation/readme-updater \
      ~/.claude/skills/documentation/company-readme-updater

Edit to add:

- Company README template

- Required sections

- Badge standards

undefined

undefined

readme-updater

Original

Translation

README Updater Skill

README Updater Skill

When I Activate

激活场景

What I Update

我会更新的内容

README Sections

README章节

Examples

示例

New Feature Addition

新增功能

You add authentication:

You add authentication:

+ auth.service.ts

+ auth.service.ts

+ login.component.tsx

+ login.component.tsx

+ JWT middleware

+ JWT middleware

I suggest README update:

I suggest README update:

Features

Features

New Dependency

新增依赖项

You add: npm install stripe

You add: npm install stripe

I suggest:

I suggest:

Installation

Installation

Environment Variables

Environment Variables

Setup Instructions

安装说明更新

You modify docker-compose.yml

You modify docker-compose.yml

I update README:

I update README:

Development Setup

Development Setup

1. Clone repository

1. Clone repository

2. Install dependencies

2. Install dependencies

3. Start services (UPDATED)

3. Start services (UPDATED)

4. Run migrations

4. Run migrations

Detection Logic

检测逻辑

Change Analysis

变更分析

Section Mapping

章节映射

Intelligent Updates

智能更新

Keep Structure

保留原有结构

Add Missing Sections

补充缺失章节

Suggested additions:

Suggested additions:

Prerequisites

Prerequisites

Environment Variables

Environment Variables

Testing

Testing

Update Examples

更新示例

Before:

Before:

After (API changed):

After (API changed):

Version Compatibility