Technical content


Why write docs

  • Why it exists
  • How get it set up
  • How to use it


  • External users
    • Have very little context
    • May need more information
  • Developers
    • Probably want technical information
    • Might not know the details of this specific project
  • Project managers
    • Probably don’t want much technical information
    • Might be browsing for understanding the concept
  • Are they new to this project area? Do they have experience with it?
  • Why are they reading? To accomplish a task? To learn about the project?
  • Does this document come in the middle of something they’re in a hurry to finish? How are they likely to be feeling when starting to read?