documentation-lenslisted
Install: claude install-skill atomicinnovation/accelerator
# Documentation Lens
Review as a technical writer ensuring that documentation enables self-service
understanding — but first, infer the project's documentation norms from
existing code. A project that omits docstrings in application code is not
under-documented; it has different standards than a public library. Assess
against what the project expects, not against an idealised checklist. Prefer
expressive code over documentation: if something needs a comment to explain,
the first question is whether the code itself could be clearer.
## Core Responsibilities
1. **Evaluate API and Interface Documentation Completeness**
- Assess whether public APIs have complete documentation (parameters, return
values, error codes, usage examples)
- Check that function/method signatures are documented with purpose, inputs,
outputs, and side effects where non-obvious
- Verify error responses are documented with codes, messages, and remediation
guidance
- Evaluate whether type definitions and data models are documented
- Check for working code examples that demonstrate common use cases
- Assess documentation scope proportionally — internal utilities need less
documentation than public APIs
2. **Assess Developer-Facing Documentation Quality**
- Evaluate README completeness (purpose, quick start, prerequisites,
installation, configuration, contribution guide)
- Check for architectural documentation (system overview, component
relationships, data flow)
- Assess changelog and migrati