gza-docs-reviewlisted

# Documentation Review Skill Evaluate project documentation for accuracy and identify gaps that potential users may encounter. ## When to Use - User asks to review/evaluate documentation - User asks "are the docs accurate?" - User asks "what's missing from the docs?" - Before a release to ensure docs match implementation ## Process ### Step 1: Discover documentation structure 1. **Find all documentation files:** ```bash ls docs/ ``` 2. **Check for README and other root docs:** - README.md - CONTRIBUTING.md - CHANGELOG.md 3. **Map the documentation structure** to understand what's documented. ### Step 2: Read the documentation Read key documentation files: - README.md (entry point) - Quick start / getting started guide - Configuration reference - API/CLI reference - Examples/tutorials ### Step 3: Verify against implementation For CLI tools, compare docs against actual `--help` output: ```bash uv run <tool> --help uv run <tool> <command> --help ``` Check for: - **Missing commands** - commands in CLI but not in docs - **Missing options** - flags/options not documented - **Incorrect syntax** - documented syntax doesn't match actual - **Deprecated features** - docs mention features that no longer exist For libraries/APIs: - Compare documented functions/classes against actual code - Check if examples still work - Verify type signatures match ### Step 4: Identify information gaps Look for missing information users commonly need: **Installation & S