Working by Task Type6 minLesson 19 of 60

Docs and Summaries the Agent Writes

Documentation is one of the highest-return uses of a coding agent. It reads the code faster than you can and it never gets bored writing the boring parts. Your job is to set the standard and check the truth.

Good doc tasks

  • Explain a module to a new contributor, with a small example.
  • Write or update a README section after a change.
  • Draft a clear pull request description from the diff.
  • Turn a tangle of comments into a coherent design note.
Set the voice
Give one example of the tone and length you want. Without it, agents tend toward bloated, generic prose. With it, they match your house style.

One caution: the agent describes what the code looks like it does, not always what it actually does. Verify claims about behavior against the real code or a test.

OpenAI Cookbook (examples)Open-source examples and guides, useful patterns for generation and summarization tasks.github.com/openai
Finished this lesson? Mark it read to track your progress.