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.
中文简介正在准备中。当前显示原文说明。
安装前可以查看交给 AI 代理的指令内容。
Keep your README current with project changes.
Installation:
Features:
Usage:
Configuration:
# 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
I maintain your README structure:
# 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();
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)
I can sync with 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
*Updated: 2025-10-24 - New authentication panel*
*New feature - user profile management*
Me (Skill): Keep README current with code changes @docs-writer (Sub-Agent): Comprehensive documentation strategy
Works without sandboxing: ✅ Yes Works with sandboxing: ✅ Yes
# Project Name
Brief description
## Features
- Feature 1
- Feature 2
## Installation
```bash
npm install
// Example
Environment variables needed
How to contribute
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 --format markdown
# Generates:
# 1. README.md (via me)
# 2. Full documentation site (via @docs-writer)
# 3. API reference (via api-documenter)
# .github/workflows/docs.yml
- name: Update README
run: |
# Skill suggests updates based on changes
# Review and commit
Add company-specific README standards:
cp -r ~/.claude/skills/documentation/readme-updater \
~/.claude/skills/documentation/company-readme-updater
# Edit to add:
# - Company README template
# - Required sections
# - Badge standards
还没有评价。欢迎分享你的使用感受。
无需登录即可发表。欢迎分享使用感受、提问，或说明在哪些环境下无法运行。
还没有评论。来写第一条吧。
Auto-generate API documentation from code and comments. Use when API endpoints change, or user mentions API docs. Creates OpenAPI/Swagger specs from code. Triggers on API file changes, documentation requests, endpoint additions.
中文简介正在准备中。当前显示原文说明。
Automatic code quality and best practices analysis. Use proactively when files are modified, saved, or committed. Analyzes code style, patterns, potential bugs, and security basics. Triggers on file changes, git diff, code edits, quality mentions.
中文简介正在准备中。当前显示原文说明。
Check dependencies for known vulnerabilities using npm audit, pip-audit, etc. Use when package.json or requirements.txt changes, or before deployments. Alerts on vulnerable dependencies. Triggers on dependency file changes, deployment prep, security mentions.
中文简介正在准备中。当前显示原文说明。
Generate conventional commit messages automatically. Use when user runs git commit, stages changes, or asks for commit message help. Analyzes git diff to create clear, descriptive conventional commit messages. Triggers on git commit, staged changes, commit message requests.
中文简介正在准备中。当前显示原文说明。
Detect exposed secrets, API keys, credentials, and tokens in code. Use before commits, on file saves, or when security is mentioned. Prevents accidental secret exposure. Triggers on file changes, git commits, security checks, .env file modifications.
中文简介正在准备中。当前显示原文说明。
Continuous security vulnerability scanning for OWASP Top 10, common vulnerabilities, and insecure patterns. Use when reviewing code, before deployments, or on file changes. Scans for SQL injection, XSS, secrets exposure, auth issues. Triggers on file changes, security mentions, deployment prep.
中文简介正在准备中。当前显示原文说明。