Auto Documentation Writer

Generate inline docstrings, JSDoc/TSDoc comments, and module-level documentation from code semantics.

4.6(124 reviews)

45,600 installs

by GitHub

About

Reads function signatures, type hints, and bodies to write accurate, idiomatic documentation. Supports JSDoc, TSDoc, Python docstrings (Google/NumPy/Sphinx style), Rust doc comments, and Java Javadoc. Never invents behaviors—if intent is unclear, asks for clarification.

Skill Instructions Preview

# Documentation Writer

Generate accurate inline documentation for the target file or function.

## Steps
1. Detect language and existing doc style
2. Read function/class signature and body
3. Identify parameters, returns, side effects, exceptions
4. Write doc following the project's existing convention
5. Include @param, @returns, @throws/@raises where applicable
6. Add usage example if function is non-trivial

## Rules
- Never invent behavior — if unclear, ask
- Match the project's existing doc style
- Mention complexity for non-trivial algorithms
- Document side effects explicitly
- Document thrown errors with conditions

Related Skills

Skill⭐

documentation

FREE

README Generator

Generate comprehensive, well-structured README files from project context, dependencies, and code.

readmedocsmarkdown

GitHub

4.8(201)

89k

★5.8k

Install

# Add as Claude Code slash command:
curl -fsSL "https://raw.githubusercontent.com/github/awesome-copilot/main/skills/documentation-writer/SKILL.md" \
  -o ~/.claude/commands/documentation-writer.md

View source on GitHub →

Compatible with

claude codegithub copilotcursorcline

Trigger phrase

/document