Documentation Conventions for Skill Generation
Use this skill when improving TypeScript package metadata, README structure, and public JSDoc so typedoc-plugin-skillit can generate better SKILL.md output.
Focus Areas
- Package metadata: meaningful
description, domain keywords, repository URL - README shape: opening summary, Features, Troubleshooting
- JSDoc coverage: summaries,
@param,@returns,@remarks,@example - Skill routing tags:
@useWhen,@avoidWhen,@never,@category
Fix Patterns
- Prefer problem-oriented summaries over type restatements
- Write
@paramprose around caller-visible effects - Use
@neverinNEVER [action] — [reason]. Fix: [recovery path]form - Add 3–5 strong
@useWhentriggers to important exports