Engineering role

AI Technical Writer

An AI technical writer that reads your code and tickets, writes the docs, and flags the ones gone stale.

Give it a repository and it writes the documentation engineers put off: READMEs that pass the five-second test, API references from the actual route definitions, migration guides for breaking changes, and tutorials that start from zero. Put it on a schedule and it rereads what merged each week and flags the pages it made wrong.

Things you could ask for

Written the way you would actually say them. The agent plans the steps itself.

  • “Read ourcompany/api-service and write an API reference for every public endpoint: parameters, response shape, auth, error codes and one example each.”
  • “Rewrite our README so someone new can tell what this is, why they would use it and how to start, in the first screen.”
  • “Every Friday, read what merged to main this week and list the docs pages that no longer match the code, with the corrected text.”
  • “This Linear epic introduces a breaking change to the webhook payload. Draft the migration guide before the release.”
  • “Turn these onboarding notes in Notion into a step-by-step quickstart a new engineer can finish in fifteen minutes.”

What you get back

Documentation written into a Google Doc or Notion page for you to review — or, from a local agent with shell access, straight into your docs folder on a branch. Staleness checks come back as a list of pages, what changed in the code, and the replacement text.

Where it is the wrong tool

  • A remote agent cannot run the code samples it writes. It has no shell, so treat every snippet as untested until you, your CI or a local agent with shell access has run it.
  • It documents what the code does, not what you meant it to do. Where the two differ, it will describe the bug faithfully — read the output for surprises, they are often findings.
  • It does not publish. Docs land as drafts in Google Docs, Notion or (from a local agent) a branch; a person decides what goes live.
  • Product decisions are not in the code. Why a limit is 100, or who a feature is for, has to come from you or a ticket it can read.

Starting an agent with this role

  1. 1Create a Burrak account — any plan works, and your first week is $1.
  2. 2In the Marketplace, open the Roles tab, find Technical Writer and choose “Start an agent as Technical Writer”. That creates a remote agent with the role’s instructions in its system prompt.
  3. 3Connect the tools it needs — GitHub, Google Docs, Notion, Linear — from Connectors.
  4. 4Give it a brief. It keeps working in the cloud after you close the tab, and you are only charged while it is actually working.

The Technical Writer role, in practice

Can it keep our docs up to date automatically?
It can tell you, every week, exactly which pages drifted and what they should now say. Applying the change is a review step on purpose: docs that silently rewrite themselves are how a wrong sentence ends up live with nobody having read it.
Does it follow our style guide?
Give it the guide — a Notion page or a Google Doc — and it follows it, and the agent’s memory keeps your conventions between runs. Without one it defaults to plain, second-person, present-tense writing.
Can it generate an OpenAPI spec?
Yes, from your route definitions and validators. Check it against the running service before you publish it: a spec is a promise to other developers, and it is only as right as the code it was read from.

Capability reference

Summarised from the role’s instructions, which are adapted from the agency-agents collection (AgentLand Contributors), used under the MIT licence.

  • READMEs that answer what it is, why it matters and how to start in seconds
  • API references with complete, working examples
  • Tutorials that take a beginner from zero to working
  • Audits existing docs for accuracy, gaps and stale content
  • Migration guides for every breaking change
Your first 7 days for $1

Your AI assistant is waiting.
Put it to work today.

Put an agent on the work that never needed a human in the first place — the research, the reports, the follow-ups — and take the week back.

$1 for your first week · Cancel anytime · Works on Mac, Windows, iPhone, Android & Web