What problem does it solve?
This Skill eliminates the burden of outdated, incomplete, or missing technical documentation that slows down development, hinders team onboarding, and creates inconsistencies between code and its accompanying guides.
Core Features & Use Cases
- Documentation Auditing: Scans existing docs for stale references, broken links, and misalignment with the current codebase, proposing targeted patches for fixes.
- Multi-format Doc Generation: Creates API documentation, README files, architecture guides, code comments (JSDoc, docstrings, etc.), changelog entries, and migration guides tailored to the project's tech stack.
- Consistency Enforcement: Applies project-specific documentation standards and best practices, including anti-hallucination protocols that verify all code references against source files before inclusion.
- Use Case: For a fast-moving TypeScript project with 60+ exported APIs, use this skill to automatically generate JSDoc comments for all undocumented public functions, update the README to reflect new CLI flags, and flag any architecture docs that reference deprecated services.
Quick Start
Use the documentation-engineer skill to audit all project documentation for accuracy against the current codebase and propose prioritized patches for any stale or missing content.