wk-workstyle-docs
Installation
SKILL.md
Workstyle — Code Documentation
Governs documentation comments and inline comments so public APIs are
documented and every comment explains WHY, not WHAT. Part of the
wk-workstyle family. Project settings are authoritative — this skill fills
gaps only, never overrides. When a linter/formatter config governs a rule
below, that config wins; see wk-workstyle Step 0 for the
project-style-authority probe.
When to Use
Auto-invoked whenever the agent adds or edits a doc comment, docstring, inline comment, or any new public function/method/class. Trigger contexts:
- Adding or editing a JSDoc block, Python docstring, Rustdoc
///, Go doc comment, or Ruby YARD comment. - Writing or editing an inline
//,#, or block comment. - Declaring a new public function, method, or class in any language.
- Editing code adjacent to an existing comment (stale-comment check applies).