code-documentation
TSDoc standards for TypeScript/JavaScript code. Automatically invoked when writing, reviewing, or editing any TSDoc comments, code documentation, or API documentation. (project)
How do I install this agent skill?
npx skills add https://github.com/youdotcom-oss/agent-skills --skill code-documentationIs this agent skill safe to install?
- Gen Agent Trust Hubpass
The skill provides templates and workflows for TSDoc documentation. It is susceptible to indirect prompt injection because it processes user-provided source code and comments to perform automated maintenance and documentation updates without sufficient sanitization or boundary markers.
- Socketpass
No alerts
- Snykpass
Risk: LOW · No issues
- Runlayerpass
6 files scanned · No issues
What does this agent skill do?
Code Documentation Skill
Purpose
This skill provides TSDoc format templates, type documentation guidelines, and maintenance workflows. Use this when:
- Writing or editing TSDoc comments for any function, type, or module
- Reviewing documentation quality
- Creating comprehensive API documentation
- Documenting complex type structures
- Cleaning up non-compliant comments (performance notes, timestamps, inline explanations)
- Synchronizing out-of-sync TSDoc with code changes
- Removing orphaned documentation for deleted code
Key Standard: No @example sections - tests and stories serve as living examples.
Quick Reference
- Creating TSDoc: See workflow.md for the generation workflow
- Maintaining TSDoc: See maintenance.md for cleanup and sync guidelines
This skill contains detailed templates for:
- Public API Functions
- Internal Module Documentation
- Public and Internal Types
- Helper Functions
- Behavioral Programming Functions
- Special Annotations (Security, Performance, Deprecated)
- Type Documentation (Complex Objects, Unions, Functions, Utilities, Branded Types, etc.)
Navigation
- workflow.md - TSDoc generation workflow (4 phases)
- maintenance.md - Comment policy, sync tasks, orphaned doc handling
- public-api-templates.md - Templates for public-facing APIs
- internal-templates.md - Templates for internal code and modules
- type-documentation.md - Comprehensive type documentation templates
Related Skills
- typescript-lsp: Use for type verification and discovery during documentation workflow. Essential for Phase 1 (type analysis) and Phase 2 (usage discovery) of the TSDoc generation process. Run
lsp-hoverto verify signatures,lsp-referencesto find usages, andlsp-symbolsto understand file structure.
How can the creator link this skill?
Add the canonical catalog link to the repository README so users can inspect current installs and available audits. The publishing guide covers the complete discovery path.
<a href="https://skillzs.dev/skills/youdotcom-oss/agent-skills/code-documentation">View code-documentation on skillZs</a>