atw: Re: Screenshots in user doco - Yes or No?
- From: "Donald Halley" <donald@xxxxxxxxxxxx>
- To: <austechwriter@xxxxxxxxxxxxx>
- Date: Wed, 29 Mar 2006 14:55:21 +0930
We tend to put screenshots in our user doco as it helps to keep things
in context. Especially if the system doesn't have screen titles.
Using SnagIt, linked graphics in Word and a meaningful naming convention
for the screenshots doesn't make updating all that onerous.
Regards
Donald Halley
MAXEN Pty Ltd.
Phone: +61 (08) 8231 7900
Fax: +61 (08) 8231 3766
<http://www.maxen.com.au/ <blocked::http://www.maxen.com.au/> >
Disclaimer
This message contains privileged and/or confidential information
intended only for the use of the addressee named above.
If you are not the intended recipient of this message you are hereby
notified that you must not disseminate, re-transmit, copy or take any
action in reliance on it. If you have received this message in error,
please notify MAXEN immediately, and delete this email from your system.
Any loss/damage incurred by using this material is not the sender's
responsibility. Any views expressed in this message are those of the
individual sender, except where the sender specifically states them to
be the views of the MAXEN Pty Ltd. We do not guarantee that this
material is free from viruses or any other defects
________________________________
From: austechwriter-bounce@xxxxxxxxxxxxx
[mailto:austechwriter-bounce@xxxxxxxxxxxxx] On Behalf Of Craig Bligh
Sent: Wednesday, 29 March 2006 2:25 PM
To: austechwriter@xxxxxxxxxxxxx
Subject: atw: Screenshots in user doco - Yes or No?
Guys,
Fundamental question. Do you include screenshots in your printed doco or
not? Why? Why not?
At the moment I'm trying to convince a company director that we don't
need screenshots in our printed reference materials, despite a mandate
to have the doco as user-friendly as possible (audience is teachers). At
the moment we use screenshots in our getting started training notes
(covering most common features), but not in our reference guide.
I've argued that adding screenshots will push the ref guide from about
450 pages to around 650-700, making it less likely that somebody will
pick up the doco in the first place. (I did also argue that since
screens change every other day, it's a nightmare to maintain.)
So from a user's point of view, is it more user-friendly to include
screenshots for a novice reader?
Thanks,
Craig
Craig Bligh
MXL Consolidated Pty Ltd
Level 1, 261 George Street
Sydney NSW 2000
Phone +61 2 8249 0022
Fax +61 2 8249 0099
Email craig.bligh@xxxxxxx <mailto:craig.bligh@xxxxxxx>
www.mxl.com <http://www.mxl.com/>
MXL: Wise Software Solutions for the Global Education
Market<http://www.mxl.com/images/mxl_email_signature.gif>
Other related posts:
