/add-documentation
Generate JSDoc/docstrings for functions
$ npx -y skills add CoWork-OS/CoWork-OS --skill add-documentation --agent claude-codeHow it fires
How this skill gets triggered: by you, by Claude, or both.
- Fires itselfAuto-invocation. Claude auto-loads it when your prompt matches the work.Auto-invocation is when the right skill fires by itself at the right moment, driven by a FLOW.md router and a hook, instead of you invoking it by name. It is the difference between a skill being installed and a skill actually getting used.Read the full definition →
- You can call itInvoke it directly when you want it.
- Slash command
/add-documentation
Context preview
The summary Claude sees to decide when to auto-load this skill.
Generate JSDoc/docstrings for functions
SKILL.md
add-documentation.SKILL.mdname: add-documentation description: "Generate JSDoc/docstrings for functions"
Add Documentation
Purpose
Generate JSDoc/docstrings for functions
Routing
- Use when: Use when users ask for in-code docs, docstring addition, or API-level comments.
- Do not use when: Don't use for content translation or narrative changelogs.
- Outputs: Updated code artifacts with improved inline documentation.
- Success criteria: Retains behavior while improving doc clarity and consistency.
Trigger Examples
Positive
- Use the add-documentation skill for this request.
- Help me with add documentation.
- Use when users ask for in-code docs, docstring addition, or API-level comments.
- Add Documentation: provide an actionable result.
Negative
- Don't use for content translation or narrative changelogs.
- Do not use add-documentation for unrelated requests.
- This request is outside add documentation scope.
- This is conceptual discussion only; no tool workflow is needed.
Parameters
| Name | Type | Required | Description | |---|---|---|---| | path | string | Yes | Path to the file to document | | style | select | Yes | Documentation style |
Runtime Prompt
- Current runtime prompt length: 523 characters.
- Runtime prompt is defined directly in `../add-documentation.json`.
Local-first personal agentic OS and everything app for coding, knowledge work, web design, automations, and artifacts.
Repo: CoWork-OS/CoWork-OS
Other skills on cowork-os.
- /attack-path-analysis
Use when Codex is already in the attack-path-analysis phase of a security scan or the user explicitly asks to trace a security finding from source to sink and calibrate severity. Do not use as the primary trigger for full PR, commit, branch, patch, or repository scans.
Open skill - /deep-security-scan
Use when the user asks for a deep, exhaustive, multi-pass, or variance-reducing repository-wide Codex Security scan. Run repeated independent repository-wide discovery passes with worker-specific threat models, semantically merge candidates, synthesize one canonical validation
Open skill - /finding-discovery
Use when Codex is already in the finding-discovery phase of a security scan or the user explicitly asks to discover candidate security findings in a repository or code change. Do not use as the primary trigger for full PR, commit, branch, patch, or repository scans.
Open skill - /fix-finding
Use when the user explicitly asks to fix and verify a validated or plausible security finding. Do not use as the primary trigger for full PR, commit, branch, patch, or repository scans.
Open skill - /security-diff-scan
Use when the user asks for a security review of a pull request, commit, branch diff, working-tree patch, or other Git-backed change set.
Open skill - /security-scan
Use when the user asks for a repository-wide or scoped-path security scan.
Open skill