# Function Documentation

> Document public functions with: a brief description of what the function does, @param for each pa... Use when documenting code and APIs. Documentation category skill.

- Skill: `majiayu000/function-documentation` (Agent Skill, multi-file: 2 files)
- Install (CLI): `npx skillmds@latest add majiayu000/function-documentation`
- Raw SKILL.md: https://api.skillmd.com/api/skills/majiayu000/function-documentation/raw
- Safety review: pending
- Works with: Claude Code, Claude.ai, OpenAI Codex
- Category: Docs & Writing
- Author: majiayu000 (https://skillmd.com/u/majiayu000)
- Updated: 2026-09-21
- Page: https://skillmd.com/skills/majiayu000/function-documentation

---


# Function Documentation

Document public functions with: a brief description of what the function does, @param for each parameter with type and description, @returns for the return value, @throws for exceptions, and @example for non-obvious usage. TypeScript types reduce documentation needs but descriptions of behavior are still valuable. Internal/private functions need less documentation.