code-documentation

Name: code-documentation
Author: youdotcom-oss

github.com/youdotcom-ossDevelopment9851 installsUpdated 5d ago

About code-documentation

A skill for creating and maintaining TSDoc in TypeScript projects, for developers documenting APIs, types, and modules. It provides templates and workflows for generating and synchronizing comments, with a policy that tests and stories serve as examples.

Key features

01TSDoc templates for APIs and types
02Four-phase documentation workflow
03Comment cleanup and synchronization
04Guidance for removing orphaned docs
05No @example sections

Use cases

01Documenting public API functions and types
02Reviewing or updating TSDoc comments
03Synchronizing comments after code changes

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/youdotcom-oss/agent-skills --skill code-documentation

After installing, type/code-documentationin Claude Code to confirm it loaded.

Bundled files

References and scripts installed along with SKILL.md.

references/

internal-templates.md

maintenance.md

public-api-templates.md

type-documentation.md

workflow.md

Details

From the project README

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-hover to verify signatures, lsp-references to find usages, and lsp-symbols to understand file structure.

Comments

Markdown supported

Details

Author: youdotcom-oss
Repository: youdotcom-oss/agent-skills
Category: Development
Installs: 51
GitHub stars: 98

Report

More skills

All skills

remotion-render

github.com/inference-sh

1.6M

Render videos from React/Remotion component code via inference.sh. Pass TSX code, get MP4. Supports all Remotion APIs: useCurrentFrame, useVideoConfig, spring, interpolate, AbsoluteFill, Sequence. Configurable resolution, FPS, duration, codec. Use for: programmatic video generation, animated graphics, motion design, data-driven videos, React animations to video. Triggers: remotion, render video from code, tsx to video, react video, programmatic video, remotion render, code to video, animated video, motion graphics code, react animation video

improve-codebase-architecture

github.com/mattpocock

1.2M

Scan a codebase for architecture improvement opportunities, present them as a visual HTML report, then dive deep into whichever one you pick.

design-mobile-apps

github.com/designed-by-ai

1.2M

Design mobile app screens with Sleek, edit Sleek projects, and implement their designs in React Native or HTML

vercel-react-best-practices

github.com/vercel-labs

863.8k

React and Next.js performance optimization guidelines from Vercel Engineering. This skill should be used when writing, reviewing, or refactoring React/Next.js code to ensure optimal performance patterns. Triggers on tasks involving React components, Next.js pages, data fetching, bundle optimization, or performance improvements.