10 Ways to Improve Your Documentation

This article shares 10 ways to improve documentation.  It’s written for software development in the project life cycle, it applies well to knowledge bases and support documentation.

Here are the topics it covers:

  1. Document with pictures if possible
  2. Give examples
  3. Don’t presume to assume
  4. Anticipate problems
  5. Test your documentation
  6. Humanize your work
  7. Explore new technologies
  8. Do the documentation yourself if possible
  9. Coordinate end-user documentation with internal/system documentation
  10. Follow department or corporate documentation guidelines

Check out the article and read about each topic in the original article here.


Also published on Medium.