writing-kdoc

Installation
SKILL.md

Writing KDoc

Write concise, contract-focused KDoc that matches the Kotlin code, tests, and project style.

Core Rules

  • Write KDoc in Korean. Keep Kotlin identifiers, API names, tags, and code literals in their original form.
  • Do not return example code or generate usage examples.
  • Do not add new @author or @since tags. Preserve existing ones unless the user explicitly asks to remove them.
  • Document public and protected declarations when their contract is useful to callers.
  • Document internal and private declarations only when behavior is complex, non-obvious, or intentionally differs from nearby public declarations.
  • Do not generate boilerplate documentation for simple properties or obvious accessors.
  • Keep documentation aligned with the code's actual behavior, tests, and project style.

Korean Style

Installs
11
Repository
dungsil/skills
First Seen
Jul 22, 2026