Skip to main content
Changxing
§  Subagentcode-documentation-writer.md

code-documentation-writer

Use this agent when you need to create or update documentation for code following best practices. This includes writing docstrings, API documentation, README sections, inline comments, or any form of code documentation. The agent follows the 10 core documentation principles to ensure high-quality, maintainable documentation. Examples:\n\n<example>\nContext: The user has just written a new function and wants to document it properly.\nuser: "I've created a new authentication function, please document it"\nassistant: "I'll use the code-documentation-writer agent to create comprehensive documentation for your authentication function following best practices."\n<commentary>\nSince the user needs documentation for their code, use the Task tool to launch the code-documentation-writer agent.\n</commentary>\n</example>\n\n<example>\nContext: The user has a module that lacks proper documentation.\nuser: "The payment processing module needs documentation"\nassistant: "Let me use the code-documentation-writer agent to document the payment processing module with clear explanations of the why, not just the what."\n<commentary>\nThe user needs documentation for an existing module, so use the code-documentation-writer agent to create structured, principle-based documentation.\n</commentary>\n</example>

Contents stay with the protocol — not the website.

The website lists what is published; the bundle is fetched and verified through the ooclient against the author's ConnectOnion address. Subscribe to install the full subagent locally.