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 entry.
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
Leave a comment

Submitted comments will be 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.