Screenshots in Your Documentation

It's always important to provide illustrations in your user and training materials. Make sure that the screenshots look professional.

Don't use real customer data in your examples. You have an obligation to protect confidential or sensitive data. (If you haven't looked at yours lately, you may want to look through them.)

If you use technology or a graphics package to obfuscate or cover sensitive information, make sure that someone can't take the layers apart to access the data.

Make sure that your screenshots match the step that you're defining. Make sure all field names and titles match.

 
Trackbacks
  • No trackbacks exist for this post.
Comments

  • 3/11/2010 10:39 AM Craig wrote:
    Snagit has a handy feature called Blur that can be used to, well, blur user logins and passwords before I insert screen grabs into documentation. Very nice to have.
    Reply to this
  • 10/13/2010 12:47 AM Marc Achtelig wrote:
    It's not only customer data that should not be visible, but it's also your own data. For example, if you take a screen capture of a web application, don't show which web sites are open on other browser tabs. Don't show which programs are visible on your task bar. Avoid showing version numbers, and dates and other things which may soon be obsolete.
    For a list of good screen capture and post processing tools, see http://www.indoition.com/screen-capture-tools-survey.htm
    Reply to this
Leave a comment

Submitted comments are subject to moderation before being displayed.

 Enter the above security code (required)

 Name (required)

 Email (will not be published) (required)

 Website

Your comment is 0 characters limited to 3000 characters.