[Author Prev][Author Next][Thread Prev][Thread Next]
[Author Index (this month)][Thread Index (this month)][Top of Archive]

Re: Writing User Guide and Help for Wireless Application Portal

Subject: Re: Writing User Guide and Help for Wireless Application Portal
From: "Saradha Krishnamurty" <saradha -dot- krishnamurty -at- gmail -dot- com>
To: Lauren <lt34 -at- csus -dot- edu>
Date: Tue, 6 Feb 2007 08:03:54 +0530

Thank you to each one of you for your valuable guidance. I am in the
process of writing a user manual for a dashboard testing equipment. While
on the job, i was offered another project to write to a wap portal. I had
no clue about it though i had a fair idea of the subject matter. I prepared
a draft ToC and while preparing the ToC, i included screen shots as well.
But, was not sure whether i am in the right track or not. Many thanks for
the guidance.

Regards
Saradha


On 2/4/07, Lauren <lt34 -at- csus -dot- edu> wrote:


That's a tall order. Have you written other documents before? Everyone
develops their own way to tackle a writing project and one person's way
may
not be the way you will wind up doing things.

For me, in a nutshell, I outline the process, get screenshots from the
process, describe the process in detail and use the screenshots as
necessary, then I run through process according to the documentation and
update content and screenshots so that it is balanced and approachable. I
may run through the document a few times before I get to a draft. I
generally do not use all of the detailed content and screenshots, but I
find
it best to trim my documents from too much information than to try and
fill-in gaps later. The outline is very important because it dictates
flow,
so I revisit the outline of my document to make sure that it flows well.

If you use FrameMaker and WebWorks, then your "Help feature" will be easy.

Lauren

-----Original Message-----
From: techwr-l-bounces+lt34=csus -dot- edu -at- lists -dot- techwr-l -dot- com
[mailto:techwr-l-bounces+lt34=csus -dot- edu -at- lists -dot- techwr-l -dot- com] On Behalf Of
Saradha Krishnamurty
Sent: Saturday, February 03, 2007 3:07 AM
To: techwr-l -at- lists -dot- techwr-l -dot- com
Subject: Writing User Guide and Help for Wireless Application Portal

Hi,

I am a novice to the field of Technical Writing and new to this list
group.
I seek advice on how to write a User Guide and Help feature for a Wireless
Application Portal.

Thank you
Saradha
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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

Now shipping: Help &amp; Manual 4 with RoboHelp(r) import! New editor,
full
Unicode support. Create help files, web-based help and PDF in up to 106
languages with Help &amp; Manual: http://www.helpandmanual.com

---
You are currently subscribed to TECHWR-L as lt34 -at- csus -dot- edu -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/lt34%40csus.edu


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.


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

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

Now shipping: Help &amp; Manual 4 with RoboHelp(r) import! New editor,
full Unicode support. Create help files, web-based help and PDF in up
to 106 languages with Help &amp; Manual: http://www.helpandmanual.com

---
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.

Follow-Ups:

References:
RE: Writing User Guide and Help for Wireless Application Portal: From: Lauren

Previous by Author: Writing User Guide and Help for Wireless Application Portal
Next by Author: guide vs manual
Previous by Thread: RE: Writing User Guide and Help for Wireless Application Portal
Next by Thread: Re: Writing User Guide and Help for Wireless Application Portal

[Top of Archive] | [Author Index (this month)] | [Thread Index (this month)]

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

Sponsored Ads