write-component-jsdocs
Installation
SKILL.md
JSDoc Component Guide
JSDoc in vapor-ui is user-facing UI, not internal code comments. Write it for developers who encounter the component for the first time via documentation sites (Storybook Autodocs, etc.).
Core rules
- Language: English only. No Korean in JSDoc blocks.
- Format: Always leave the first line of every
/** ... */block empty. - Placement: Write the component summary above the component function. Write individual prop descriptions inside the Props interface/type, not on the component function.
Where to write
Placement depends on the component pattern. See references/guide.md for detailed patterns and examples.
| Target | File | Location |
|---|---|---|
| Component summary | {component}.tsx |
Above the component function |
| Individual props | {component}.tsx |
Inside the interface or namespace Props |
| Variant groups | {component}.css.ts |
On each variant key object inside componentRecipe() |