API & Technical Documentation Writer

What it does

API & Technical Documentation Writer is a Cursor agent playbook named technical-writer. AgenticKit installs it so a session can adopt this role instead of acting as a generic coding assistant.

The technical-writer agent translates complex software systems into lucid, developer-friendly documentation. It generates OpenAPI 3.0 specs, interactive code samples in multiple languages, setup guides, and architectural overview diagrams.

Authors OpenAPI specifications, developer docs, and SDK quickstart guides. Technical writer for Cursor that writes clear developer documentation, OpenAPI specs, API references, tutorials, and architecture diagrams.

Why it exists

A pile of agent files is not a team. technical-writer exists so one job, api & technical documentation writer, has a written brief, required skills, and a stop condition.

It ships in the Engineering Kit. Skills it must read: Technical Documentation & OpenAPI Spec Design; Project Conventions & CURSOR.md Standards; SaaS Architecture Patterns & Multi-Tenancy. Commands that adopt this role: /write-docs: Technical Documentation & API Reference Writer; /release: Release Notes & Changelog Generator; /feature-spec: PRD & Product Feature Requirement Spec.

When to use it

• Writing comprehensive developer documentation for public APIs
• Creating onboarding documentation in docs/ and README.md
• Maintaining up-to-date SDK guides and migration playbooks

When not to use it

• Do not ask technical-writer to do a different role's job. If you need a launch post, switch agents.
• Do not keep the same chat after this agent has finished its artifact. Start a reviewer in a new thread.
• Do not invoke every agent in the kit for a small change.

Example workflow

1. Install the Engineering Kit so .cursor/agents/technical-writer is on disk.
2. Run /write-docs: Technical Documentation & API Reference Writer, or start a chat and tell Cursor to adopt the technical-writer role.
3. The agent should read: Technical Documentation & OpenAPI Spec Design; Project Conventions & CURSOR.md Standards; SaaS Architecture Patterns & Multi-Tenancy.
4. It produces the artifact for this role only, then stops.
5. A different agent or you review. Same-chat self-review is not a review.

Example usage

Example: "You are technical-writer. Writing comprehensive developer documentation for public APIs. Read technical-docs before you edit."

Or let the pipeline invoke it: /write-docs: Technical Documentation & API Reference Writer.

Capabilities you should actually see: OpenAPI 3.0 (Swagger) and TypeScript type documentation

Example output

• technical-writer should leave files or a written verdict, not a vibe check. OpenAPI 3.0 (Swagger) and TypeScript type documentation Developer quickstart tutorials and copy-paste code snippets
• Engineering agents should touch the slice they were given (schema, route, test, or review note) and nothing else.

Best practices

• OpenAPI 3.0 (Swagger) and TypeScript type documentation
• Developer quickstart tutorials and copy-paste code snippets
• System architecture markdown files and Mermaid flowcharts
• Changelogs and customer-facing release documentation
• One role per chat unless a command is explicitly orchestrating a sequence.

Common mistakes

• Using technical-writer as a synonym for 'the Cursor agent'. It is a brief, not the product.
• Skipping the required skills and hoping the role name is enough.
• Letting the writer approve its own PR.
• Invoking this agent and three unrelated ones in the same prompt.