RE: Documenting the User Interface

Subject: RE: Documenting the User Interface
From: "Sarah Bouchier" <Sarah -dot- Bouchier -at- exony -dot- com>
To: <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Thu, 11 Jan 2007 10:11:58 -0000

>I would say on this one that It Depends. I've just
>recommending removing a bunch of screenshots from
>an administrator's guide because the installation
>UI mainly consists of screens with self-evident
>fields that need to be populated with information
>like the user's name and password, port, etc.

You too, huh?

Bear in mind that few people sit down and read a manual from beginning
to end to find out about the product. Most of the time they use the
manual as a guide when going through the tasks. In this case, they
already know what the screen looks like, because they have it in front
of them.

There are still occasions when a screenshot is necessary, but they are
much fewer.

Also, it may be worth bearing in mind that if you ship internationally
you may require a different version of every screenshot for each
language.

S.

Sarah Bouchier
Technical Author

exony

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

WebWorks ePublisher Pro for Word features support for every major Help
format plus PDF, HTML and more. Flexible, precise, and efficient content
delivery. Try it today! http://www.webworks.com/techwr-l

Create HTML or Microsoft Word content and convert to Help file formats or
printed documentation. Features include single source authoring, team authoring,
Web-based technology, and PDF output. http://www.DocToHelp.com/TechwrlList

---
You are currently subscribed to TECHWR-L as archive -at- infoinfocus -dot- com -dot-

To unsubscribe send a blank email to
techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit http://lists.techwr-l.com/mailman/options/techwr-l/archive%40infoinfocus.com


To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com

Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
http://www.techwr-l.com/techwhirl/ for more resources and info.


References:
Re: Documenting the User Interface: From: Janice Gelb

Previous by Author: RE: Offer Letter
Next by Author: RE: Documenting the user interface
Previous by Thread: Re: Documenting the User Interface
Next by Thread: Re: Documenting the user interface


What this post helpful? Share it with friends and colleagues:


Sponsored Ads