jsdoc-writer

Sterne4

Forks0

Aktualisiert3. April 2026 um 15:16

Add JSDoc to code entities. TRIGGER when: user asks to add/write/improve JSDoc (e.g., "add jsdoc to Foo", "jsdoc for Bar").

Installation

Mit Codex oder Claude installieren Kopieren Sie diesen Prompt, fügen Sie ihn in Codex, Claude oder einen anderen Assistant ein und lassen Sie die Skill-Seite prüfen und installieren.

In Manus ausführen

Quelle

imaman

imaman/skills

GitHub-Repository öffnen Creator-Repositorys ansehen

Download

In Manus ausführen

Verwandte BerufeSOC

Basierend auf der SOC-Berufsklassifikation

SoftwareentwicklerInformatik- und Mathematikberufe·SOC 15-1252

SKILL.md

readonly

name	jsdoc-writer
description	Add JSDoc to code entities. TRIGGER when: user asks to add/write/improve JSDoc (e.g., "add jsdoc to Foo", "jsdoc for Bar").

Add precise yet tight JSDoc for the entities specified by the user. Avoid slop. Make it the JSDoc that engineers will love to read, not the JSDoc that PMs will love to show off.

Important:

Never restate the function name in prose. The signature already says what — the JSDoc should say why, or surface constraints and gotchas (nullability, side effects, mutation, valid ranges).
@param/@returns descriptions only when the type and name don't tell the full story. A bare @param {string} name beats @param {string} name - The name.
One to three lines for most functions. Longer only for genuinely complex contracts.
Match the voice of the surrounding codebase.

Scope (pass as arguments):

Name the functions, classes, methods, types, or files to document.
If a file path is given, document all exported entities in that file.

Mehr aus diesem Repository

gleiches Repository

top-dog

imaman/skills

Orchestrate the review skills (review-dog, regression-dog) into one deduplicated, adjudicated report. TRIGGER when: the user wants a combined/full/aggregated review of a branch or commit (e.g., "run the full review", "review this branch with everything", "give me the aggregated review").

2026-05-274

review-dog

imaman/skills

Review code changes for bugs, style, best practices, and adherence to project conventions.

2026-05-274

bug-dog

imaman/skills

Review new/changed code for bugs. TRIGGER when: checking for bugs, auditing new logic, or validating correctness (e.g., "any bugs here?", "check this for bugs", "is this correct?").

2026-04-114

regression-dog

imaman/skills

Review code for regressions. TRIGGER when: reviewing changes, checking for breakage, or auditing commits (e.g., "did I break anything", "review last commit").

2026-04-054

name	jsdoc-writer
description	Add JSDoc to code entities. TRIGGER when: user asks to add/write/improve JSDoc (e.g., "add jsdoc to Foo", "jsdoc for Bar").

Add precise yet tight JSDoc for the entities specified by the user. Avoid slop. Make it the JSDoc that engineers will love to read, not the JSDoc that PMs will love to show off.

Important:

Never restate the function name in prose. The signature already says what — the JSDoc should say why, or surface constraints and gotchas (nullability, side effects, mutation, valid ranges).
@param/@returns descriptions only when the type and name don't tell the full story. A bare @param {string} name beats @param {string} name - The name.
One to three lines for most functions. Longer only for genuinely complex contracts.
Match the voice of the surrounding codebase.

Scope (pass as arguments):

Name the functions, classes, methods, types, or files to document.
If a file path is given, document all exported entities in that file.