Installable skillMIT

documenting

Creates clear, maintainable documentation for code and APIs. Use when writing README files, API docs, code comments, or when asked to document code.

BY mrwoguUPDATED Oct 27, 2026
INTENDED FOR✳Claude Code>_Codex↗Cursor✦GeminiInstall in a listed agent.

instructions.md

---
name: documenting
description: 'Creates clear documentation for code and APIs'
---

<!-- PromptScript 2026-03-04T16:49:01.160Z - do not edit -->

## Principles

1. **Audience-first**: Write for the reader
2. **Examples over explanation**: Show, don't tell
3. **Keep current**: Outdated docs are worse than none
4. **Scannable**: Use headings, lists, tables

## Code Comments

- Explain WHY, not WHAT
- Document non-obvious decisions
- Keep comments in sync with code
COMPATIBILITY & REFERENCES

Platform guidance

Imported from the listed AgentSkill.sh category. Complete supplied package files and notices are retained. Required external tools and credentials are not installed. No bundled code was executed during import. Individual agent task behavior has not been tested.

Resource notes updated 2026-10-27 · Original instructions by mrwogu