jsdocslisted
Install: claude install-skill deathemperor/infinitus
Use this skill to write well-formed JSDoc for Effect public APIs.
## Workflow
When updating public API JSDoc:
1. Inspect the declaration, implementation, nearby tests, and nearby JSDoc before editing.
2. Decide whether the task is a single API fix or a module refinement pass.
3. Rewrite comments into the required documentation shape while preserving correct facts and examples.
4. For module refinements, complex APIs, or APIs with related alternatives, run the `@see` and `**Gotchas**` audits.
5. Run the narrowest relevant validation.
## Required documentation shape
Use a normal multiline JSDoc comment in TypeScript source:
```ts
/**
* Short description as one paragraph.
*
* **When to use**
*
* Optional practical usage guidance.
*
* **Details**
*
* Optional details for complex APIs, options, overloads, or behavior.
*
* **Gotchas**
*
* Optional edge cases, footguns, or surprising behavior.
*
* **Example** (Short title)
*
* Optional prose explaining the example.
*
* ```ts import.meta.vitest
* const result = example()
* ```
*
* @category constructors
* @since 1.0.0
*/
```
## Prose Rules
- Use sober, practical prose.
- Write all public JSDoc prose in English.
- Do not use jargon when a plain word works.
- Do not be clever.
- Do not add filler sections.
- The short description is required and must be exactly one paragraph.
- Make the short description stand on its own. Do not rely on `**When to use**`
to make the API understandable.
- For functions