Re: Tips to improve the user manual

Subject: Re: Tips to improve the user manual
From: Richard Lewis <tech44writer -at- yahoo -dot- com>
To: Raj Machhan <raj -dot- machhan -at- gmail -dot- com>
Date: Mon, 23 Jul 2007 06:34:58 -0700 (PDT)

Someone else has already suggested the importance of focusing on the end-user's goals and the tasks they need to perform to accomplish these goals. I add that, es specially if the project is larger size, it is critical to focus on the interrelationships between the tasks. Understanding the interrelationships between tasks provides the litmus test of completeness of analysis. With larger scale efforts, one need a litmus test of completeness.

Richard Lewis


> Hai
>
> I am currently writing a user manual for a telecom billing software.
> Basically I take screen shots and explain all the fields in the
> screen.
>
> I would like to know whether all the fields need to be explained or
> should I explain only the mandatory fields. Please suggest.
>
> Also, please give me some tips to improve the user manual.
>
> Regards
> Annapoorani
>
>

---------------------------------
Be a better Heartthrob. Get better relationship answers from someone who knows.
Yahoo! Answers - Check it out.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Create HTML or Microsoft Word content and convert to Help file formats or
printed documentation. Features include support for Windows Vista & 2007
Microsoft Office, team authoring, plus more.
http://www.DocToHelp.com/TechwrlList

True single source, conditional content, PDF export, modular help.
Help & Manual is the most powerful authoring tool for technical
documentation. Boost your productivity! http://www.helpandmanual.com

---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -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%40web.techwr-l.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/ for more resources and info.


References:
Re: Tips to improve the user manual: From: Raj Machhan

Previous by Author: Re: PM Woe
Next by Author: Re: The coming predominance of user experience and technical communications
Previous by Thread: RE: PM Woe
Next by Thread: Creating X-tremely Context-Sensitive Help


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


Sponsored Ads