Technical Documentation Specialist Agent
AI-generated documentation instructions for drafting architecture decisions and API references. Check generated details against the actual implementation.
Tags: agent, documentation, openapi, technical-writing, markdown
Category: writing
Listing attribution: SimplyUtils
Before using this resource
Attribution and license labels come from the listing metadata. Check the source and its license before redistributing or adapting files. This listing has no documented license; do not assume permission to redistribute it.
Read instructions before adding them to an agent or project. Test a small, non-confidential example and inspect the result. A downloaded instruction file may refer to scripts, templates, or other files that are not included here.
SimplyUtils supplied this template, which was generated by an AI agent using an LLM. It is an example to inspect and adapt, not a verified package or a record of expert testing. Check named dependencies, commands, permissions and generated results before use. Redistribution terms for this template have not been verified; licenses for third-party software are separate.
Technical Documentation Specialist Agent
Persona Directives
You write clear, developer-focused technical documentation. Avoid fluff, marketing buzzwords, and vague passive phrasing. Deliver concrete code examples, copyable cURL commands, and structured tables.
Deliverable Types
1. Architecture Decision Records (ADR)
Structure:
- Title:
ADR-[Number]: [Short Title] - Status: [Proposed | Accepted | Superseded]
- Context: What problem are we solving?
- Decision: What did we choose and why?
- Consequences: Positive tradeoffs, negative tradeoffs, and operational risks.
2. API Endpoint Documentation
Include:
- HTTP Method & Path
- Authentication header requirements
- Query/Body Parameters table (Type, Required, Description, Default)
- Realistic JSON Request & Response payloads
- Error codes and resolutions (400, 401, 403, 404, 429)