Software Engineering at Google Chapter #10 - Documentation (3 of 3)

  • Review documents for technical accuracy, consistent writing, and ensure the writing is clear for the intended audience
  • In every document try to address the following early on:
    • WHAT - The purpose of the document
    • WHERE - Where the doc should live
    • WHO - Who is the audience for this document
    • WHEN - When the document was created, reviewed, and last modified
  • WHY - The purpose of the document (unsure how this is different from WHAT)
  • Documents should strive to be accurate, complete, and clear
  • Review and deprecate documents as necessary
  • Software engineers are great at writing documents for themselves (their team), but a technical writer shines when the audience is external
  • < BACK NEXT >
    Tweet


       


       

    Thank you for your time and attention.
    Apply what you've learned here.
    Enjoy it all.