← ClaudeAtlas

readme-upgradelisted

Audit and upgrade project documentation quality — README.md, CONTRIBUTING.md, plugin READMEs — against the developer-tool pattern (Why, Quick Start, How it works, command tables with categories, diagram). Triggers: "improve readme" | "upgrade docs" | "readme quality" | "improve docs" | "doc audit" | "readme upgrade" | "improve contributing" | "docs health".
Roxabi/roxabi-plugins · ★ 9 · AI & Automation · score 77
Install: claude install-skill Roxabi/roxabi-plugins
# Readme Upgrade Let: σ := `.claude/stack.yml` config M := project metadata (name, description, repo URL, license) ρ := `README.md` κ := `CONTRIBUTING.md` TARGET ∈ {root, plugins, contributing, all} — default: all DIAGRAM ∈ {mermaid, ascii} — auto-detected FINDINGS := [] — audit findings per file EDITED := [] — files actually improved **Goal:** audit existing docs against the developer-tool quality pattern and apply targeted improvements. Never rewrite sections that already meet the standard — only fill gaps and strengthen weak sections. **Idempotent** — sections already meeting the checklist are skipped unless `--force` is passed. ``` /readme-upgrade → audit + improve all docs /readme-upgrade --target root → root ρ only /readme-upgrade --target plugins → all plugin READMEs /readme-upgrade --target contributing → κ only /readme-upgrade --plugin dev-core → one plugin README only /readme-upgrade --force → re-audit even passing sections ``` ## Developer-Tool Documentation Pattern The quality standard used by this skill. Applied to all docs. ### Root README checklist | # | Section | Required | Pattern | |---|---------|----------|---------| | 1 | Title + tagline | ✅ | `# Name` + one bold sentence below or badge row | | 2 | Badges | ✅ | CI, license, version on one line (shields.io) | | 3 | One-liner description | ✅ | ≤ 2 sentences: what it is + for whom | | 4 | Why / Problem |