Technical Writer agent
The Technical Writer agent writes or updates the user-facing documentation for a change. It closes Feature SDLC, so its draft also becomes the session summary.
The Technical Writer agent writes for the people who will use the change. It drafts new user-facing documentation, or updates what exists, so a feature ships with an explanation.
Where it runs
| Workflow | Step |
|---|---|
| Feature SDLC | User docs |
It is the eighth and last step of Feature SDLC. By then the session has requirements from the Product Analyst, a technical design from the Architect, backend and frontend changes, end-to-end scenarios and a security review. The writer documents what was actually decided.
Because it runs last, its output also becomes the session's summary on the session page.
Inputs
- The session task.
- A read-only snapshot of files from the project's repository, chosen for their relevance to the task.
- All seven earlier steps, in shortened form so they fit.
Outputs
A documentation draft in text: new pages or sections, changes to existing ones, and where each belongs. It is written for users of the product, not for the engineers who built it.
After this step, the session's code pass writes the change as files, using the whole session as input. It reads a fixed amount of that input, and in an eight-step workflow the last step is the most likely to be cut. The draft may or may not appear as files in the diff.
Example run
Illustrative example, not a recorded session. For filter presets, the Technical Writer adds a "Saved views" section to the existing filtering guide. It explains how to save the current filters, apply a saved view, and delete one; that saved views are personal; and that there is a limit of 20. It adds one line to the changelog draft and notes that an old screenshot in the guide will be out of date once the button appears.
Limits
- It cannot take screenshots or check how the feature looks.
- It documents the plan as described by the earlier steps. If the final diff differs, the docs can be wrong. Review both.
- Docs land only if the code pass writes them, which is not guaranteed in a long session.
- The separate Docs Writer agent in the console catalog is not used by any built-in workflow today.
Frequently asked questions
Will the docs it drafts be in the pull request?
Only if the session's code pass writes them as files. The pass reads the draft, but in a long workflow it may not see all of it. Check the diff.
Can it follow our docs style?
It reads existing files from your repository, so it tends to match them. For stricter rules, override its instructions with a custom agent named Technical Writer.