atw: Re: Screenshots in user doco - Yes or No?
- From: Charles_Boyle@xxxxxxxxxx
- To: austechwriter@xxxxxxxxxxxxx
- Date: Wed, 29 Mar 2006 14:54:09 +1000
I think this will end up as a real...It depends.....
Any "Windows" look and feel software we produce we don't provide
screenshots. That software is mainly diagnostic and tuning, and the
audience is technical so there's no reason......EXCEPT (see...always one
of those) configuration and setting screens. If their screen doesn't
match what the pic in our document shows..well it won't work.
Of course that's about 1% of what we do. The main products, well they
aren't standard interfaces, reasonably complex processes, and highly
graphical, so we tend to use a lot of pics in the user manual...but only
(as a few others have said ) where it assists in reducing complexity, and
only in the user documentation. Then there's our stuff that runs on ISO-VT
terminals, well, as some may be touch screens, some maybe keypad, some may
use dials and potentiometers....it's pointless. You'd have to provide
documentation for every type of third party terminal, and it changes a lot
(custom features) so we tend to write function/process type documents for
these, and we find that people really, really like those documents....so
it depends.
I think the main points are don't include every screen, and take an
objective look, does the image reduce complexity? Cut down on long
rambling descriptions? Provide key reference information at a glance?
Probably best summed up as....don't put it in just because it's there.
Cheers
CB
#####################################################################################
Note:
This message is for the named person's use only. It may contain confidential,
proprietary or legally privileged information. No confidentiality or privilege
is waived or lost by any mistransmission. If you receive this message in error,
please immediately delete it and all copies of it from your system, destroy any
hard copies of it and notify the sender. You must not, directly or indirectly,
use, disclose, distribute, print, or copy any part of this message if you are
not
the intended recipient. BEELINE Technologies and any of its subsidiaries each
reserve
the right to monitor all e-mail communications through its networks.
Any views expressed in this message are those of the individual sender, except
where
the message states otherwise and the sender is authorized to state them to be
the
views of any such entity.
Thank You.
postmaster@xxxxxxxxxx
#####################################################################################
#####################################################################################
This e-mail message has been scanned for Viruses and Content and cleared
by MailMarshal
For more information please visit www.marshalsoftware.com
#####################################################################################
- References:
- atw: Re: Screenshots in user doco - Yes or No?
- From: Kymberly_Fergusson
Other related posts:
- » atw: Re: Screenshots in user doco - Yes or No?
- » atw: Re: Screenshots in user doco - Yes or No?
- » atw: Re: Screenshots in user doco - Yes or No?
- » atw: Re: Screenshots in user doco - Yes or No?
- » atw: Re: Screenshots in user doco - Yes or No?
- » atw: Re: Screenshots in user doco - Yes or No?
- » atw: Re: Screenshots in user doco - Yes or No?
- » atw: Re: Screenshots in user doco - Yes or No?
- » atw: Re: Screenshots in user doco - Yes or No?
- » atw: Re: Screenshots in user doco - Yes or No?
- » atw: Re: Screenshots in user doco - Yes or No?
- » atw: Re: Screenshots in user doco - Yes or No?
- » atw: Re: Screenshots in user doco - Yes or No?
- » atw: Re: Screenshots in user doco - Yes or No?
- » atw: Re: Screenshots in user doco - Yes or No?
- » atw: Re: Screenshots in user doco - Yes or No?
- » atw: Re: Screenshots in user doco - Yes or No?
- » atw: Re: Screenshots in user doco - Yes or No?
- » atw: Re: Screenshots in user doco - Yes or No?
- atw: Re: Screenshots in user doco - Yes or No?
- From: Kymberly_Fergusson