Screenshots in Documentation

Unanswered Question
May 15th, 2011

Hi there. My name is Michele Knudson and I'm a Technical Writer for the Small Business Technology group.  I'd like to know your impressions of using screenshots in the documentation and if they improve or hinder your experience.

Right now in our Quick Start Guides, we include ones that show how to mount the device and what the front and back panel of the particular device looks like. In more advanced documentation, such as the Administration Guides, we only include those that show  a specific area of a complex GUI, or an example scenario that is hard to visualize otherwise, such as setting up a VPN tunnel.

Do you find screenshots helpful or do you only read the text? Would you like to see more, less, or no screenshots at all?

Thanks! We appreciate any feedback you can give us to help improve our documentation.

  • 1
  • 2
  • 3
  • 4
  • 5
Overall Rating: 0 (0 ratings)
rsawyer6003 Sat, 12/31/2011 - 17:53

When reading about configs I prefer no screen shots. Instead use that space for defining the options, terms, ect.

Sent from Cisco Technical Support iPhone App


This Discussion