TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
Subject:Re: Tips to improve the user manual From:"Raj Machhan" <raj -dot- machhan -at- gmail -dot- com> To:sharon -at- anthrobytes -dot- com Date:Sat, 21 Jul 2007 15:46:45 +0530
To add to what Sharon has said.
You should make efforts to know the academic or intelligence level of your
audience, and then choose your words accordingly. Also, remember that you
can create a useful manual only if you know the application fully, like the
back of your hand.
Raj
On 7/20/07, Sharon Burton <sharon -at- anthrobytes -dot- com> wrote:
> You might start looking at writing a user-centric manual, instead of a
> product-centric manual. Think about what the user is doing: What tasks do
> they need to accomplish? What are their goals? Why are they doing what
> they
> are doing? What do they need to do 4x a day and what do they do 1x a
> month,
> if ever?
>
> That should lead you to know what fields you need to explain and what you
> don't, in the context of telling the user how to do their tasks in the
> product.
>
> sharon
>
> Sharon Burton
> CEO, Anthrobytes Consulting
> 951-369-8590
> www.anthrobytes.com
>
>
> -----Original Message-----
> From: techwr-l-bounces+sharon=anthrobytes -dot- com -at- lists -dot- techwr-l -dot- com
> [mailto:techwr-l-bounces+sharon=anthrobytes -dot- com -at- lists -dot- techwr-l -dot- com]On
> Behalf Of Annapoorani Gopalan
> Sent: Thursday, July 19, 2007 8:48 PM
> To: techwr-l -at- lists -dot- techwr-l -dot- com
> Subject: Tips to improve the user manual
>
>
> 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
>
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
>
> 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 raj -dot- machhan -at- gmail -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/raj.machhan%40gmail.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.
>
>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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-