Issues to outcomes

A report of finished work answers one question for its reader: what is different for me now? An issue number and its title answer a different one: what did the tracker call it? Titles are written for whoever implements the work. The reader of a report was not there and should not need the codebase in their head to understand it.

Who the reader is

Write for the person who uses the product and pays for the work. They notice two things: what the product does when they use it, and what they or their agents can or cannot get done while working on it. Everything in the report is one of those two, or it is left out.

The shape

Write the report in this order.