← ClaudeAtlas

rnd-doc-polishlisted

Use after SHIP verdict before committing — checks and updates CLAUDE.md, README.md, project docs, and stale inline comments to reflect what the pipeline just built
oleksify/rnd-framework · ★ 0 · Data & Documents · score 75
Install: claude install-skill oleksify/rnd-framework
# Documentation Polish ## When to Use - After SHIP verdict in `/rnd-framework:rnd-start` (Phase 6, before commit options) - Manually via `/rnd-framework:rnd-review` or `/rnd-framework:rnd-audit` when doc staleness is suspected ## Process ### 1. Scope the Changes Run `git diff --name-only` (or `git diff --staged --name-only`) to get the list of changed files. ### 2. Check CLAUDE.md Read `CLAUDE.md` and nested ones (Glob `**/CLAUDE.md`). Verify: - **Repository layout** — new files/directories reflected in structure trees? - **Command/skill/agent lists** — new additions listed? - **Artifact layout** — new artifact types in the artifact tree? - **Architecture descriptions** — patterns match current state? - **Conventions** — new conventions documented? Fix stale entries in-place. Do not add docs for things that didn't change. ### 3. Check README.md Verify: - **Feature tables** — counts, rows, and descriptions match current state - **Installation/usage** — new setup steps required? - **Structure trees** — reflect new files? - **Examples** — code examples still valid? Fix stale entries. Do not rewrite accurate sections. ### 4. Check Project-Specific Docs Use Glob to scan for documentation directories common in the project: - `docs/**/*.md` - `*.md` at root (beyond CLAUDE.md and README.md) - Any `CONTRIBUTING.md`, `ARCHITECTURE.md`, or similar For each doc file that references areas touched by the pipeline, verify accuracy. Skip docs that are unrelated to the change