kdoc-documentation

What problem does it solve?

Kotlin projects often suffer from inconsistent documentation across public and internal APIs. This skill provides clear guidelines for documenting code using KDoc syntax, best practices, and cross-references to produce reliable API references.

Core Features & Use Cases

• KDoc syntax coverage: describe short summaries, detailed explanations, parameters, returns, and exceptions with Markdown support.
• Dokka-ready patterns: guidance on generating HTML and multi-module documentation.
• Cross-referencing and examples: how to link related classes, provide usage samples, and maintain consistent style.

Quick Start

Use this skill to structure Kotlin documentation for a module by creating SKILL.md with the described frontmatter and content, then follow the examples to write KDoc in your source files.