Creating a Better Documentation

Here are some steps summary for creating a better documentation. I took them from a blog from techrepublics.com.

  1. Document with picture if possible
  2. Give examples
  3. Don’t presume to assume (don’t over estimate readers)
  4. Anticipate problems
  5. Test your documentation
  6. Humanize your work
  7. Explore new technologies (efficient cost)
  8. Do the documentation yourself (if possible)
  9. Coordinate development of the end user documentation with internal/system documentation
  10. Follow department or corporate document guidelines

And I’ve found a very useful screen capture freeware named picpick. Thanks for the developer for the great software!

Creating a Better Documentation

One thought on “Creating a Better Documentation

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out / Change )

Twitter picture

You are commenting using your Twitter account. Log Out / Change )

Facebook photo

You are commenting using your Facebook account. Log Out / Change )

Google+ photo

You are commenting using your Google+ account. Log Out / Change )

Connecting to %s