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.
RE: Writing User Guide and Help for Wireless Application Portal
Subject:RE: Writing User Guide and Help for Wireless Application Portal From:"Lauren" <lt34 -at- csus -dot- edu> To:"'Saradha Krishnamurty'" <saradha -dot- krishnamurty -at- gmail -dot- com>, <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Sat, 3 Feb 2007 12:31:10 -0800
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 & 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 & Manual: http://www.helpandmanual.com
---
You are currently subscribed to TECHWR-L as lt34 -at- csus -dot- edu -dot-
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 & 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 & Manual: http://www.helpandmanual.com
---
You are currently subscribed to TECHWR-L as archive -at- infoinfocus -dot- com -dot-