How to: Write documentation

Questions to ask:

  • Does the document fulfill its purpose?
  • Is anything missing?
  • Can anything be taken out?
  • What questions will the reader have? And answer them.
  • Is the writing easy to understand?

Also Check:

  • Sentence and paragraph structure
  • Grammar
  • Word choice
  • Spelling

pluralsight – technical-writing-software-documentation

Writing That Works 

Author: Pouya Panahy

Microsoft certified DevOps engineer with passion in analysing, designing and implementing solutions for Azure Cloud with hands-on experience in security and quality assurence.

Leave a Reply