doc-gen_skill

Overview

This skill generates comprehensive, developer-friendly documentation directly from code and project metadata. It creates structured outputs including an overview, API docs, code examples, and configuration guides tailored for Kotlin Multiplatform projects and general codebases. The goal is to turn source code, comments, and usage patterns into searchable, accurate documentation ready for publishing or IDE integration.

How this skill works

The skill parses source files, function signatures, and inline comments to extract API surface and usage intent. It infers parameter descriptions, return types, and examples by analyzing code paths and tests, then synthesizes clear prose and runnable snippets. Outputs follow a consistent structure (Overview, API Documentation, Code Examples, Configuration) and can be customized by project name, target audience, and style preferences.

When to use it

• After major feature implementation to produce up-to-date API docs
• When onboarding new team members who need clear usage patterns
• Before release to generate user-facing guides and reference material
• To convert inline comments and tests into published documentation
• When integrating documentation into CI/CD or IDEs like IntelliJ

Best practices

• Keep code comments concise and descriptive to improve extraction quality
• Provide small, runnable examples and unit tests to produce accurate snippets
• Supply project metadata (name, module descriptions, environment defaults) for richer docs
• Review generated API signatures and add domain-specific explanations where needed
• Use the skill as part of CI to prevent documentation drift

Example use cases

• Generate an API reference from Kotlin Multiplatform modules for a release site
• Create quickstart and basic usage guides from core library examples
• Auto-produce configuration sections listing defaults and environment variables
• Convert test scenarios into advanced usage examples for developer docs
• Embed generated docs into an IDE panel or documentation portal