readme-updater

README 更新技能

根据项目变更更新 README。

激活时机

• ✅ 添加了新功能
• ✅ 项目结构发生变化
• ✅ 添加/移除了依赖项
• ✅ 安装说明发生变化
• ✅ 用户提到 README 或文档
• ✅ 修改了配置文件

更新内容

README 章节

安装：

• 新依赖项
• 安装步骤
• 先决条件
• 环境变量

功能：

• 新能力
• 功能变更
• 功能弃用

用法：

• API 变更
• 新示例
• 更新的截图

配置：

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

示例

添加新功能

# 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

新依赖项

# You add: npm install stripe

# I suggest:
## Installation

```bash
npm install
npm install stripe  # Added for payment processing

环境变量

STRIPE_SECRET_KEY=your_stripe_key  # Required for payments

### Setup Instructions

```bash
# You modify docker-compose.yml

# I update README:
## Development Setup

```bash
# 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

## 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

### 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

智能更新

保持结构

我会保留 README 的结构：

• 保持表情符号风格
• 保持格式一致
• 保持语气和风格
• 遵循现有组织方式

添加缺失章节

# Suggested additions:

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

## Environment Variables
```bash
DATABASE_URL=postgresql://localhost/mydb
API_KEY=your_api_key

测试

npm test

### Update Examples

```markdown
# Before:
```javascript
const result = api.getUsers();

之后（API 发生变化）：

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

## Version Compatibility

I track version-specific documentation:

```markdown
## Requirements

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

更新日志集成

我可以与 CHANGELOG.md 同步：

## Recent Changes

See [CHANGELOG.md](CHANGELOG.md) for detailed version history.

### Latest (v2.1.0)
- ✨ Added user authentication
- 🔧 Fixed memory leak in data processing
- 📝 Updated API documentation

截图管理

# I suggest when UI changes:
## Screenshots

![Dashboard](screenshots/dashboard.png)
*Updated: 2025-10-24 - New authentication panel*

![User Profile](screenshots/profile.png)
*New feature - user profile management*

与 @docs-writer 的关系

我（技能）： 根据代码变更保持 README 最新 @docs-writer（子 Agent）： 制定全面的文档策略

工作流

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

沙盒兼容性

不使用沙盒时可用： ✅ 是 使用沙盒时可用： ✅ 是

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

最佳实践

1. 保持最新 - 每添加一项功能都更新 README
2. 具体明确 - 包含版本号和先决条件
3. 添加示例 - 展示实际用法，而不只是 API
4. 包含故障排除 - 列出常见问题及解决方案
5. 徽章状态 - 保持构建/覆盖率徽章为最新

README 模板

基本结构

# Project Name

Brief description

## Features
- Feature 1
- Feature 2

## Installation
```bash
npm install

用法

// Example

配置

所需的环境变量

贡献

如何参与贡献

许可证

MIT

### Comprehensive Structure

```markdown
# Project Name
> Tagline

[Badges]

## Table of Contents
- Features
- Installation
- Usage
- API Reference
- Configuration
- Development
- Testing
- Deployment
- Contributing
- License

[Sections with detailed content]

集成

与 /docs-gen 命令集成

/docs-gen --format markdown

# Generates:
# 1. README.md (via me)
# 2. Full documentation site (via @docs-writer)
# 3. API reference (via api-documenter)

与 CI/CD 集成

# .github/workflows/docs.yml
- name: Update README
  run: |
    # Skill suggests updates based on changes
    # Review and commit

自定义

添加公司特定的 README 标准：

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

# Edit to add:
# - Company README template
# - Required sections
# - Badge standards

相关工具

• api-documenter 技能：API 文档
• @docs-writer 子 Agent：全面的文档
• git-commit-helper 技能：更新的提交消息
• /docs-gen 命令：生成完整文档