Documentation Agent

Docs drift from code within weeks. Agents can diff code against docs on every PR and propose updates, turning documentation from a quarterly chore into a continuous process.

A technical writer who pair-programs with every PR — not someone rewriting the manual from memory once a year.

Scenario

After a PR adds `POST /v2/refunds`, the doc agent updates the API reference with request/response schemas, adds a changelog entry, and flags the old `/v1/refunds` page as deprecated.

Solution

In Coding Agents, apply Documentation Agent to this scenario: After a PR adds `POST /v2/refunds`, the doc agent updates the API reference with request/response schemas, adds a changelog entry, and flags the old `/v1/refunds` page as deprecated. Identify the inputs, run the technique, validate the output, and note one thing you would monitor in production.

Do this before moving to the next module — reading alone is not enough.

Open the Code Walkthrough below and run it locally. Change one parameter related to Documentation Agent (e.g. model, temperature, top_k, or tool name), observe the difference in output, and write 2–3 sentences explaining what changed.

Highlighted lines show where Documentation Agent happens in the code.

1async function syncDocsFromPR(prDiff) {2  const apiChanges = extractAPIChanges(prDiff);3  if (apiChanges.length === 0) return;4  const updates = await docWriter.generate({5    changes: apiChanges,6    styleGuide: await loadStyleGuide(),7    templates: ["api-reference", "changelog"],8  });9  await github.createPR({10    branch: "docs/sync-" + prDiff.number,11    title: "docs: update API reference for PR #" + prDiff.number,12    files: updates,13  });14}

• Treating Documentation Agent as a black box without evaluation
• Ignoring cost and latency in production
• Skipping error handling for documentation agent

Quick recap — the most important points from this module.