documentation-generator_skill

Overview

This skill analyzes source code to automatically generate technical documentation and architecture diagrams. It keeps API references, module overviews, and onboarding materials synchronized with the codebase. The generated artifacts are designed for engineers and technical stakeholders who need accurate, current documentation. It runs locally to preserve source code confidentiality.

How this skill works

The skill parses project source files, extracts comments, type information, and code structure, and synthesizes human-readable documentation from those artifacts. It generates API reference pages, architecture diagrams (class, module, or service-level), and contextual explanations based on code relationships. Outputs are produced in common formats (Markdown, HTML, diagram files) and can be integrated into CI pipelines or documentation sites. All processing occurs on the local machine without sending code to external servers.

When to use it

• After merging a feature or refactor to update API docs before a release.
• During onboarding to produce architecture overviews and module guides for new engineers.
• In CI to automatically regenerate docs so the documentation stays in sync with code changes.
• When preparing handoffs or audits that require up-to-date technical references.

Best practices

• Keep code comments and type annotations current to improve documentation quality.
• Run the generator as part of CI/CD so docs are updated automatically on merges.
• Review and edit generated text for design decisions or high-level rationale not present in code.
• Store generated docs in a dedicated docs folder and version them alongside source when needed.
• Limit sensitive data in comments; the tool runs locally but avoid embedding secrets in source.

Example use cases

• Produce an up-to-date API reference for a public or internal library before a release.
• Generate service and sequence diagrams to explain system architecture for cross-team reviews.
• Create onboarding packets with module summaries, common workflows, and example usages.
• Automate documentation updates in CI so documentation changes cannot be forgotten.