auto-doc-updaterlisted
Install: claude install-skill roedyrustam/claudevibeskills
# Auto Doc Updater
Keep documentation accurate, current, and in sync with the actual codebase.
---
## Core Principle
**Documentation drift is a bug.** Treat outdated docs with the same severity as a broken test.
Every meaningful code change should trigger a documentation review.
---
## When to Update Docs (Triggers)
| Code Change | Docs to Update |
|-------------|-----------------|
| New API endpoint/route | API reference, OpenAPI spec |
| New environment variable | `.env.example`, README setup section |
| New dependency | README prerequisites, package list |
| Breaking change | CHANGELOG, MIGRATION guide |
| New feature | README features list, user guide |
| Config schema change | Config docs, example configs |
| New CLI command/flag | CLI reference, `--help` text |
| Architecture change | Architecture diagram, ADR (Architecture Decision Record) |
| Deprecation | CHANGELOG, deprecation notice with timeline |
---
## README Maintenance
### Standard README Structure
```markdown
# Project Name
One-line description.
## Features
- Feature 1
- Feature 2
## Quick Start
\`\`\`bash
git clone ...
pnpm install
pnpm dev
\`\`\`
## Prerequisites
- Node.js 20+
- PostgreSQL 16+
## Environment Variables
| Variable | Required | Description |
|----------|----------|-------------|
| `DATABASE_URL` | Yes | PostgreSQL connection string |
## Project Structure
\`\`\`
src/
├── ...
\`\`\`
## Scripts
| Command | Description |
|---------|-------------|
| `pnpm dev` | Start dev server |