code documentation engineer

The problem

Existing documentation is often stale, incomplete, or based on outdated assumptions. Developers waste time tracing code to verify if the README or API docs actually match the implementation.

What it does

• Analyzes project structure, entry points, and execution flows to establish a source-of-truth mental model.
• Audits existing READMEs and docstrings to identify contradictions, stale info, and missing sections.
• Generates API documentation by tracing routes through controllers and services to verify actual behavior.
• Maps database schemas, environment variables, and infrastructure config directly from source files.
• Produces documentation audit reports highlighting critical gaps and security-sensitive findings.

Why this beats prompting it yourself

Generic prompts often hallucinate features based on file names. This skill enforces a "code-first" rule, refusing to document any behavior that cannot be verified in the source, ensuring 100% accuracy.

Use cases

• Generating a comprehensive README for a legacy repository with zero documentation.
• Auditing a complex API to ensure the public docs match the actual validation rules and response codes.
• Onboarding new engineers by creating verified architecture diagrams and data flow maps.
• Identifying accidentally committed secrets or credentials in config files before deployment.

Known limitations

Will not document behavior that cannot be established from available evidence. Explicitly flags low-confidence findings rather than guessing.