К основному содержанию
скилл CX Codex

readme-updater — скилл для Claude Code: что делает и как установить

Скилл readme-updater обновляет README автоматически, когда меняется структура проекта, добавляются зависимости или новые фичи.

MIT ★ 788 обновлён 2026-07-03

Установить в Claude Code · Через Skills CLI (Vercel) Все способы и платформы ↓
npx skills add alirezarezvani/claude-code-tresor --skill readme-updater -a claude-code
Открыть на GitHub

Что делает readme-updater

Скилл следит за изменениями в коде и предлагает обновить README: если добавился новый эндпоинт — допишет в секцию Usage, если появилась зависимость — в Installation, если изменился docker-compose.yml — в Setup. Срабатывает на изменения в package.json, .env.example, новые роуты и компоненты.

Использует инструменты Read, Write, Edit и Grep. Сохраняет стиль документа: эмодзи, форматирование, тон.

Может создать отсутствующие секции (Prerequisites, Environment Variables, Testing) и синхронизировать с CHANGELOG.md. Для комплексной документации делегирует работу субагенту @docs-writer.

Какие задачи решает

  • синхронизировать README с изменениями в коде
  • добавить новую зависимость в секцию Installation
  • обновить примеры использования после изменения API
  • дописать переменные окружения из .env.example
  • создать секцию Prerequisites для нового требования

Примеры запросов агенту

  • Обнови README — добавил аутентификацию через JWT
  • Допиши в README инструкцию по запуску с docker-compose
  • README устарел после рефакторинга API, приведи в порядок

Как установить readme-updater

1Через Skills CLI (Vercel)

npx skills add alirezarezvani/claude-code-tresor --skill readme-updater -a claude-code

2Вручную: положить файлы

~/.claude/skills/readme-updater/SKILL.md

Папка скилла целиком; для одного проекта — .claude/skills/readme-updater/

По шагам, с командами для каждой платформы: Как установить скилл в Claude Code: пять способов

Вопросы о readme-updater

Как установить readme-updater в Claude Code?

Выполни npx skills add alirezarezvani/claude-code-tresor --skill readme-updater -a claude-code. Скилл окажется в ~/.claude/skills/readme-updater/SKILL.md.

Что делает readme-updater?

Отслеживает изменения в проекте (новые зависимости, фичи, роуты, переменные окружения) и предлагает обновить соответствующие секции README. Сохраняет структуру и стиль документа.

Когда readme-updater запускается автоматически?

При изменениях в package.json, .env.example, docker-compose.yml, добавлении новых роутов, компонентов или когда ты упоминаешь README в промпте.

Исходный текст

SKILL.md · MIT
---
name: readme-updater
description: Keep README files current with project changes. Use when project structure changes, features added, or setup instructions modified. Suggests README updates based on code changes. Triggers on significant project changes, new features, dependency changes.
allowed-tools: Read, Write, Edit, Grep
---

# README Updater Skill

Keep your README current with project changes.

## When I Activate

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

## What I Update

### README Sections

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

## Examples

### New Feature Addition

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

### New Dependency

```bash
# You add: npm install stripe

# I suggest:
## Installation

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

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

## Intelligent Updates

### Keep Structure

I maintain your README structure:
- Preserve emoji style
- Keep formatting consistent
- Maintain tone and voice
- Respect existing organization

### Add Missing Sections

```markdown
# Suggested additions:

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

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

## Testing
```bash
npm test
```
```

### Update Examples

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

# After (API changed):
```javascript
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 Integration

I can sync with CHANGELOG.md:

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

## Screenshot Management

```markdown
# 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*
```

## Relationship with @docs-writer

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

### Workflow
1. I detect changes
2. I suggest README updates
3. For full docs → Invoke **@docs-writer** sub-agent
4. Sub-agent creates complete documentation

## Sandboxing Compatibility

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

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

## Best Practices

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

## README Templates

### Basic Structure

```markdown
# Project Name

Brief description

## Features
- Feature 1
- Feature 2

## Installation
```bash
npm install
```

## Usage
```javascript
// Example
```

## Configuration
Environment variables needed

## Contributing
How to contribute

## License
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]
```

## Integration

### With /docs-gen Command

```bash
/docs-gen --format markdown

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

### With CI/CD

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

## Customization

Add company-specific README standards:

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

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

## Related Tools

- **api-documenter skill**: API documentation
- **@docs-writer sub-agent**: Comprehensive docs
- **git-commit-helper skill**: Commit messages for updates
- **/docs-gen command**: Full documentation generation

© alirezarezvani · MIT · alirezarezvani/claude-code-tresor

Похожие скиллы

Все скиллы по теме «Тексты и документация» →
docs-updater giuseppe-trisciuoglio Скилл docs-updater для Claude Code анализирует изменения Git и обновляет документацию проекта. Запускается при подготовке релиза, синхронизации README или перед pull request. CX Codex +1 3 700установок update-readme Samarth Gupta Скилл update-readme для Claude Code обновляет существующий README.md по текущему состоянию кода, истории git и CHANGELOG. Обновляет документацию, сверяя её с проектом. CX Codex +1 ★ 276звёзд репо readme-generator Jeremy Longshore Скилл для автоматической генерации README-файлов в проектах. Активируется по фразе «readme generator» или «readme» в запросе. CX Codex +1 273установок create-readme-section centminmod Команда create-readme-section для автоматической генерации структурированных секций README: установка, API, документация, вклад в проект. Экономит время на форматирование и соответствие best practices. CX Codex +1 ★ 2 744звёзд репо readme-optimization Samuel Berthe Скилл readme-optimization для Claude Code и Codex анализирует README репозитория и переписывает его в посадочную страницу для разработчиков. Он проверяет команды запуска по коду и отсекает лишние бейджи. CX Codex +1 13 600установок readme-blueprint-generator официальный github Скилл readme-blueprint-generator для GitHub Copilot собирает сведения из документации проекта и готовит структурированный README.md. Основа README — материалы из .github/copilot и copilot-instructions.md. CX Codex +1 9 662установок

Из того же набора27

Весь набор →
dependency-auditor Скилл dependency-auditor проверяет зависимости на уязвимости и проблемы с лицензиями, а затем предлагает варианты исправления. Запускайте проверку после изменений в файлах зависимостей или перед деплоем. CX Codex +1 ★ 788звёзд репо test-gen Команда test-gen пишет тесты к готовому коду: юнит-тесты функций, компонентные, интеграционные, e2e и тесты API. Фреймворк и порог покрытия задаются флагами. CX Codex +1 ★ 788звёзд репо secret-scanner Скилл secret-scanner находит случайно вписанные пароли, токены и приватные ключи в коде до того, как они попадут в коммит или репозиторий. CX Codex +1 ★ 788звёзд репо api-documenter Скилл api-documenter для Claude Code собирает спецификации API по коду и комментариям. Формирует документацию при изменении маршрутов или подготовке OpenAPI-документа. CX Codex +1 ★ 788звёзд репо test-generator Скилл test-generator генерирует базовые заготовки тестов для новых функций и React-компонентов под популярные тест-раннеры. CX Codex +1 ★ 788звёзд репо docs-gen Команда docs-gen анализирует кодовую базу и собирает API-документацию, руководства и справочные материалы. Подходит для генерации сайта документации и автодеплоя. CX Codex +1 ★ 788звёзд репо scaffold Команда scaffold генерирует каркас проекта или отдельного компонента: исходники, конфиги, тесты и документацию. Фреймворк и набор фич задаются флагами. CX Codex +1 ★ 788звёзд репо code-reviewer Скилл code-reviewer для Claude Code автоматически проверяет качество, стиль и типовые уязвимости при сохранении файлов или перед коммитом. CX Codex +1 ★ 788звёзд репо

Спонсоры проекта

Компании, которые помогают держать аналитику открытой