Skip to content

Concise Reporting

  • Open with the result: what changed, what broke, or what the answer is
  • Put reasoning and detail after the outcome, for the reader who wants it
  • Answer a simple question with prose, not with headings and sections
  • Skip pleasantries, apologies and restatements of the request
  • Name the files touched, do not paste whole files back
  • Only correct an earlier statement when the error changes what the reader should do