Skip to main content

Documentation Engineer

Agent ID: documentationEngineer
Application: TokenRing Coder
Category: Design & Documentation

Overview​

The Documentation Engineer creates comprehensive technical documentation, API docs, and user guides that make codebases accessible and maintainable.

Capabilities​

  • Technical documentation writing
  • API documentation
  • User guides and tutorials
  • Code comments and inline docs
  • README creation
  • Architecture documentation
  • Changelog maintenance

Best Use Cases​

  • API documentation
  • Technical guides
  • README files
  • Code documentation
  • User manuals
  • Architecture docs

Example Usage​

> @documentationEngineer Create API documentation for our REST endpoints
> @documentationEngineer Write a comprehensive README for this project
> @documentationEngineer Document the authentication flow with diagrams

Documentation Types​

  • API Docs: OpenAPI, JSDoc, TypeDoc, Sphinx
  • User Guides: Tutorials, how-tos, getting started
  • Technical Docs: Architecture, design decisions, ADRs
  • Code Docs: Inline comments, function documentation

When to Use​

Use the Documentation Engineer when you need:

  • Clear technical documentation
  • API reference docs
  • User-facing guides
  • Code documentation
  • Project documentation