Complete AI Training
Sign inGet my AI kit

Your job's AI kit

Get your AI kit

Tell us who you are and what you do. We show you your kit right away and email you the link: skills, prompts, AI agents, MCP servers and courses for your job.

500+ jobs ready, and we make a kit for any other job. No payment needed to look.

Share

AI agent for technical writers

API Changelog to Docs Gap Agent

Make sure every user-visible code change has matching, accurate documentation before or soon after release.

Quality controlCreatingIT and developmentWriters
See how it worksGet access
API Changelog to Docs Gap Agent: what goes in, what the agent does and what you get

What it does

A release ships with 40 merged pull requests, and a month later a customer reports that a renamed setting is still described by its old name in the docs. This agent runs after each release. It reads the merged pull requests and the changelog and extracts what changed for users: endpoints, parameters, settings, error codes and removals. It maps each changed item to the doc pages that mention it, using search on names and paths. For each match, it drafts update notes or new text in a branch. It then checks coverage: every changed item must either have a doc page updated, a new page planned, or a reason it needs no change. Any gap loops back to the search. The writer reviews and approves before publishing. Edge case: a pull request has no description, so the agent reads the code diff and asks the author.

How it works

Follow the arrows from top to bottom. The orange dashed arrow is the loop: when a check fails, the agent goes back and tries again.

Start and resultWhat it doesA check on its own workWaits for your OKGoes back and retries
Yes, continueYes, continueApprovedNoNo 1 STARTS WHEN Release is tagged 2 USES A TOOL Read merged pull requests and the changelog 3 DOES List the user-visible changes with names and paths 4 USES A TOOL Search the docs for pages that mention each item 5 DOES Draft update notes or new text in a branch 6 CHECKS THE RESULT Is every changed item covered, planned or excused? If not: search again with other names and draft text forthe gaps. Back to step 4. 7 USES A TOOL Compare the drafts with the API spec and examples 8 CHECKS THE RESULT Do the names, types and defaults match the spec? If not: correct the text and ask the pull request authorabout unclear changes. Back to step 5. 9 DOES Write a coverage list for the writer 10 YOU APPROVE Writer approves before publishing 11 RESULT Docs branch ready to publish
Read the steps as a list
  1. Release is tagged
  2. Read merged pull requests and the changelog
  3. List the user-visible changes with names and paths
  4. Search the docs for pages that mention each item
  5. Draft update notes or new text in a branch
  6. Is every changed item covered, planned or excused?If not: search again with other names and draft text for the gaps. Back to step 4.
  7. Compare the drafts with the API spec and examples
  8. Do the names, types and defaults match the spec?If not: correct the text and ask the pull request author about unclear changes. Back to step 5.
  9. Write a coverage list for the writer
  10. Writer approves before publishingThe agent waits here for your OK.
  11. Docs branch ready to publish

How it decides

A change is user-visible when it alters an endpoint, parameter, setting, default or error. It is covered when a page or section names it correctly.

  • Treat renamed or removed items as breaking and put them first
  • Require a doc page or a written reason for every changed endpoint
  • Read the code diff when a pull request has no description
  • Compare every example with the API spec

Make it yours

Every agent is a starting point. You choose these settings for your own situation.

  • Repositories and branches to read
  • What counts as user-visible
  • Docs repository structure
  • Spec format
  • Coverage list format

What keeps you in control

It always asks you first

  • Writer approves the docs changes before publishing

Hard limits

  • Never publish docs directly
  • Never describe behavior that the code does not show

It stops when

  • Done: all items covered and the writer approves
  • Stop: the changelog is missing and no pull requests are linked to the release

Set it up

We guide you through the set-up, step by step

Members get the full set-up guide for this agent. No technical skills needed: you copy, paste and upload.

10 minto set it up in your AI
5 AIsChatGPT, Claude, Copilot, Gemini, Grok
  • One set of instructions to paste into your AI, with the clicks for ChatGPT, Claude, Microsoft 365 Copilot, Gemini and Grok
  • The agent then walks you through connecting your own data, one source at a time
  • A downloadable copy with the flow chart, the rules and the full guide
Get access to this agent

An example run

What happensA release has 38 merged pull requests, and 17 change user-facing items. The agent finds that 12 are covered by existing pages and drafts updates. Five have no page. A parameter was renamed from timeout_s to timeout, which appears on four pages. The check finds one new error code without any mention, so the agent adds it. A spec comparison finds a default of 30 instead of 60 in a draft, which it corrects. The writer approves.

More agents for technical writers

Compliance · Quality control

Editorial Revision Compliance Agent

A revision compliance map and response for the editor.

7 steps1 check7 jobs
Quality control · Writers

Article Structure Revision Agent

A tracked structural revision that keeps the argument fully supported.

7 steps1 check6 jobs
Compliance · Creatives

Copy Approval Chain Tracker Agent

One locked copy version with a complete record of who approved it

9 steps2 checks7 jobs
Quality control · Automation

Web Content Translation Sync Agent

Keep every translated page in sync with its source, with verified text and rendering.

10 steps2 checks7 jobs