New: 97,000+ skills indexed from GitHub repos with 100+ stars · every skill safety-checkedBrowse top skillsTop skills
Esc to closeBrowse all skills
Submit a skillBrowse skills
Submit a skillBrowse skills

Agent skill

Standard Jsdoc

by backpine in backpine/effect-worker-mono

Write, insert, or update Effect public API JSDoc so it satisfies the standard-jsdoc oxlint rule.

MITAuto-check passedDevelopment

Install Standard Jsdoc

skills CLI
$ npx skills add backpine/effect-worker-mono --skill standard-jsdoc -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI
$ gh skill install backpine/effect-worker-mono standard-jsdoc --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy
$ git clone --depth 1 https://github.com/backpine/effect-worker-mono.git skills-src && mkdir -p .claude/skills && cp -r skills-src/repos/effect/.agents/skills/standard-jsdoc .claude/skills/standard-jsdoc && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Facts

Skill name
standard-jsdoc
GitHub stars
132
Token cost
~1.3k tokens
SKILL.md length
646 words
Files
1
Skills in repo
2
Repo updated
First seen
Licence
MIT

At a glance

Write, insert, or update Effect public API JSDoc so it satisfies the standard-jsdoc oxlint rule.

  • Works in 3 steps: When to use → Details → Gotchas
  • Fixing JSDoc comments
  • SKILL.md covers Required documentation shape, Writing rules, Tag rules and Updating existing JSDoc, plus 1 more section
  • Calls pnpm

What it does

Standard Jsdoc is an agent skill from backpine/effect-worker-mono. Write, insert, or update Effect public API JSDoc so it satisfies the standard-jsdoc oxlint rule. Use when adding or fixing JSDoc comments, resolving standard-jsdoc diagnostics, preparing docs for JSON extraction, or reviewing public API documentation.

Its SKILL.md is about 1.3k tokens, which your agent loads only when the skill is triggered. It is a single SKILL.md file with no bundled scripts.

It sits in Development, covering Technical documentation. It works with TypeScript. The licence is MIT.

When your agent uses it

  • Fixing JSDoc comments
  • Resolving standard-jsdoc diagnostics
  • Preparing docs for JSON extraction
  • Reviewing public API documentation

Example prompts

  • “/standard-jsdoc”

Workflow steps

3 steps, taken from the first numbered list in SKILL.md.

  1. When to use
  2. Details
  3. Gotchas

What it can do on your machine

Read from SKILL.md and the folder at commit c1a6559. It shows what the files ask for, not the result of running them.

  • Tool permissions

    Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.

    From allowed-tools in the SKILL.md frontmatter.

  • Runs code

    Shell commands in SKILL.md call:

    • pnpm

    From the folder's file list and the shell code blocks in SKILL.md.

  • Network

    No URLs in SKILL.md. Its commands use pnpm, which can reach the network depending on how they are called.

    From URLs in SKILL.md, links to its own repository left out.

  • Credentials

    Names no API keys, tokens, secrets or passwords.

    From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

Standard Jsdoc loads about 1.3k tokens when it runs. Until then it costs about 67 tokens; SKILL.md has 646 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~67
When it runs · the whole SKILL.md, loaded when a task matches
~1.3k

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Auto-check passed

The automated check found no risky patterns in SKILL.md.

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

The full file from backpine/effect-worker-mono at commit c1a6559, republished under its MIT licence (© backpine). 646 words, ~1,308 tokens.

Download SKILL.mdSave it as .claude/skills/standard-jsdoc/SKILL.md (or your agent's skills folder).
name
standard-jsdoc
description
Write, insert, or update Effect public API JSDoc so it satisfies the standard-jsdoc oxlint rule. Use when adding or fixing JSDoc comments, resolving standard-jsdoc diagnostics, preparing docs for JSON extraction, or reviewing public API documentation.

Use this skill to write well-formed JSDoc for Effect public APIs.

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
 * const result = example()
 * ```
 *
 * @category constructors
 * @since 1.0.0
 */

Writing rules

  • Use sober, practical prose.
  • 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.
  • Optional sections must appear in this order:
    1. **When to use**
    2. **Details**
    3. **Gotchas**
  • Include an optional section only when it has useful, non-empty content.
  • **When to use** is important when the API has close alternatives, trade-offs, or @see tags. If @see tags are present, inspect the referenced APIs and add **When to use** when it helps readers choose between them.
  • Add @see only for APIs that are similar to the documented API but intended for different situations or usage patterns. Do not add @see for loosely related helpers, dependencies, implementation details, or general background links.
  • Before deciding whether to include **Gotchas**, inspect the implementation and nearby tests for edge cases, footguns, preconditions, surprising behavior, or important failure modes. Add **Gotchas** only when you find a real gotcha worth documenting.
  • Use exactly one blank line between the short description, sections, examples, and tags.
  • Do not use Markdown headings such as # Heading or ad hoc bold headings such as **Notes**; only the standard headings are allowed.
  • Examples must use **Example** (Title), optional prose, and exactly one non-empty ts code fence.
  • Example titles must be unique after trimming and lowercasing.
  • Do not use @example.
  • Do not put TypeScript code fences outside **Example** (Title) sections.
  • Inline {@link Symbol} targets must resolve to TypeScript symbols; do not link to URLs with {@link}.
  • Do not document module-level comments; module JSDoc is ignored by this rule.
  • @internal means the item is ignored; do not rewrite it as public docs.
  • Default exports are ignored by this rule and do not need JSDoc.
  • Do not add unsupported constructs such as enums or empty exports in checked files.
Show full SKILL.md (318 more words)Show less

Tag rules

When multiple tags are present, keep them in this order:

  1. @deprecated
  2. @default
  3. @see
  4. @category
  5. @since

Root declarations:

  • Require @category.
  • Require @since with stable semver like 1.2.3.
  • May use @deprecated with a non-empty message.
  • May use repeated non-empty @see tags, but only for similar APIs with different usage patterns.
  • Must not use @default.

Namespaces and declarations inside namespaces:

  • Require @since with stable semver like 1.2.3.
  • May use optional @category.
  • May use @deprecated with a non-empty message.
  • May use repeated non-empty @see tags, but only for similar APIs with different usage patterns.
  • Must not use @default.

Members:

  • JSDoc is optional.
  • When member JSDoc is present, it must follow the same short description, section, example, spacing, and tag-order rules.
  • May use optional @since with stable semver like 1.2.3.
  • May use @default with a non-empty value.
  • May use @deprecated with a non-empty message.
  • May use repeated non-empty @see tags, but only for similar APIs with different usage patterns.
  • Must not use @category.

Updating existing JSDoc

When fixing or updating existing docs:

  1. Preserve correct facts and examples.
  2. Rewrite the layout into the standard template.
  3. Move usage guidance into **When to use**; when @see tags are present, inspect the referenced APIs and explain selection guidance if useful.
  4. Move option, overload, and behavior details into **Details**.
  5. Move caveats into **Gotchas**; if no caveat is already documented, inspect the implementation and nearby tests before deciding whether a **Gotchas** section is warranted.
  6. Convert @example tags and loose ts fences into **Example** (Title) sections.
  7. Preserve valid @see, @deprecated, @default, @category, and @since tags.
  8. Remove @see tags that do not point to similar APIs with meaningfully different usage patterns.
  9. Remove sections that would be empty.

Validation

After changing JSDoc governed by the rule, run the narrowest relevant validation:

sh
pnpm test packages/tools/oxc/test/standard-jsdoc.test.ts
pnpm check:tsgo

If the changed package has generated docs, also run pnpm docgen from that package directory.

© backpine, MIT. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file

Files

Just SKILL.md in repos/effect/.agents/skills/standard-jsdoc of backpine/effect-worker-mono.

Open the folder on GitHubat commit c1a6559

Compare with similar skills

Standard Jsdoc next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

Standard Jsdoc compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Standard Jsdoc this skillbackpine/effect-worker-mono132—~1.3kAutomated safety check: PassMIT
Add Packageremix-run/remix33k—~2kAutomated safety check: PassMIT
ScratchpadEffect-TS/effect-smol782—~459Automated safety check: PassMIT
evlog Enricher Creatorevloghq/evlog1.9k—~1.7kAutomated safety check: PassMIT
Enforce Rules For Typescriptmoeru-ai/airi50k—~3.4kAutomated safety check: PassMIT
Adk Readme WriterBrainDAO/adk-ts119—~2.6kAutomated safety check: NotesMIT

Similar skills

  • Add Package

    remix-run/remix

    Create or align a package in the Remix monorepo to match existing package conventions.

    33k GitHub stars~2k tokensUpdated yesterday
    DevelopmentAuto-check passed

  • Scratchpad

    Effect-TS/effect-smol

    Extract the JSDoc example nearest the active source selection or cursor into ./scratchpad as a TypeScript file.

    782 GitHub stars~459 tokensUpdated 2 mo ago
    DevelopmentAuto-check passed

  • evlog Enricher Creator

    evloghq/evlog

    Guides adding a new built-in enricher to the evlog package, covering the source, tests, docs, README, a related skill and a changeset.

    1.9k GitHub stars~1.7k tokensUpdated yesterday
    DevelopmentAuto-check passed

  • Enforce Rules For Typescript

    moeru-ai/airi

    Enforce AIRI's TypeScript and Vue source rules for imports, naming, comments, JSDoc, fallbacks, stateful and protocol code, and module design.

    50k GitHub stars~3.4k tokensUpdated today
    DevelopmentAuto-check passed

  • Adk Readme Writer

    BrainDAO/adk-ts

    ADK-TS README specialist. An agent skill from BrainDAO/adk-ts.

    119 GitHub stars~2.6k tokensUpdated 3 mo ago
    DevelopmentAuto-check: notes

  • Typedoc

    ankitskvmdam/clean-jsdoc-theme

    Expert guidance for the @clean-jsdoc-theme/typedoc plugin — using clean-jsdoc-theme v5 with TypeDoc / TypeScript.

    179 GitHub stars~3k tokensUpdated 1 mo ago
    DevelopmentAuto-check passed

More from backpine/effect-worker-mono

  • Effect V4

    backpine/effect-worker-mono

    A skill your agent uses when writing, debugging, or reviewing Effect-TS v4 (4.0.0-beta) code in this repo — resolving an Effect API, verifying a signature/error shape, or finding idiomatic usage.

    132 GitHub stars~937 tokensUpdated 4 mo ago
    Auto-check passed

Works with

Categories

Questions about Standard Jsdoc

What does Standard Jsdoc do?

Write, insert, or update Effect public API JSDoc so it satisfies the standard-jsdoc oxlint rule. Standard Jsdoc is an agent skill from backpine/effect-worker-mono. Write, insert, or update Effect public API JSDoc so it satisfies the standard-jsdoc oxlint rule.

When should I use Standard Jsdoc?

Standard Jsdoc fits situations like: fixing JSDoc comments; resolving standard-jsdoc diagnostics; preparing docs for JSON extraction; reviewing public API documentation.

How do I install Standard Jsdoc in Claude Code?

Run `npx skills add backpine/effect-worker-mono --skill standard-jsdoc -a claude-code`. Or copy the skill folder (repos/effect/.agents/skills/standard-jsdoc in backpine/effect-worker-mono) into .claude/skills/standard-jsdoc in your project. Claude Code loads it when a task matches its description.

How do I install Standard Jsdoc in Codex?

Run `npx skills add backpine/effect-worker-mono --skill standard-jsdoc -a codex`. Or copy the skill folder (repos/effect/.agents/skills/standard-jsdoc in backpine/effect-worker-mono) into .agents/skills/standard-jsdoc in your project. Codex loads it when a task matches its description.

Can I use Standard Jsdoc in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add backpine/effect-worker-mono --skill standard-jsdoc -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/standard-jsdoc, .gemini/skills/standard-jsdoc, .github/skills/standard-jsdoc and .opencode/skills/standard-jsdoc in your project.

What does Standard Jsdoc need to run?

Going by SKILL.md and its folder, Standard Jsdoc needs the command-line tools its instructions call (pnpm).

Does Standard Jsdoc access the network?

SKILL.md contains no URLs. Any network use would come from the scripts or tools the agent runs. This is read from the text; nothing was executed.

Is Standard Jsdoc safe to install?

Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.

What licence does Standard Jsdoc use?

Standard Jsdoc is published under the MIT licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does Standard Jsdoc use?

About 1.3k tokens (SKILL.md is roughly 5.2k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.

What are the alternatives to Standard Jsdoc?

Skills that share tags, products or a category with Standard Jsdoc: Add Package (remix-run/remix, 33k stars), Scratchpad (Effect-TS/effect-smol, 782 stars), evlog Enricher Creator (evloghq/evlog, 1.9k stars) and Enforce Rules For Typescript (moeru-ai/airi, 50k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Standard Jsdoc?

backpine (a GitHub organization) maintains it in backpine/effect-worker-mono, which has 132 GitHub stars. The repository holds 2 skills in this directory. The repository was last updated on May 26, 2026.

Source: backpine/effect-worker-mono on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.