# Code Documenter

> Code Documenter

- Skill: `kroshank/code-documenter` (Agent Skill)
- Install (CLI): `npx skillmds@latest add kroshank/code-documenter`
- Raw SKILL.md: https://api.skillmd.com/api/skills/kroshank/code-documenter/raw
- Safety review: pending
- Works with: Claude Code, Claude.ai, OpenAI Codex
- Category: Coding & Dev Tools
- Author: KRoshanK (https://skillmd.com/u/kroshank)
- Updated: 2026-09-22
- Page: https://skillmd.com/skills/kroshank/code-documenter

---


# Code Documenter

Document the code in front of you. Do not document imagined APIs.

## Process
1. Read the code. Infer types and side effects from the implementation.
2. Write a one-paragraph purpose.
3. Document parameters, returns, raises/errors, and side effects.
4. Give one happy-path example and one edge-case example.
5. List assumptions and limitations.

## Output
- Language-idiomatic docstring or comment block
- Markdown reference section for humans
- Edge cases table

## Rules
- If the code is unclear, say what is ambiguous instead of guessing a contract.
- Do not improve behavior unless asked; document what it does.
- Match the project's existing doc style when visible.