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: Writing about a product on a PDA From:"Dana Worley" <dana -at- campbellsci -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Wed, 01 Oct 2003 09:55:43 -0600
> On Tue, 30 Sep 2003 22:25:47 0000, Worzel Gummidge
> > I'm going to write about our new product that utilizes a PDA (runs
> > on a PDA platform).
> >
> > Having never written about this type of thing before, what are some
> > of the things that I should include in the manual, beyond the TOC,
> > body, and index?
On 30 Sep 2003 at 20:33, Peter Neilson wrote:
> I've never read any of the documents that might have come with my PDA,
> and I have never needed to. PDA apps should require no documentation
> other than built-in help. On the other hand, I had to use a lot of
> web searching to figure out how to overcome a designed-in hardware
> bug.
>
> Your assumption of TOC, body, and index is probably inappropriate.
I disagree with Peter's advice that a traditional manual is
inappropriate. Like with any software application, look at it closely
and determine what the user needs to know to operate it
successfully. Also remember that just because *we* are all
technology savvy, it doesn't necessarily mean the majority of our
users will be.
We have datalogger support software that runs on Palm & CE
devices. You have to set up the station, and then you can collect
data, set the clock, send programs, etc. You also have to follow a
couple of steps when installing the software, or it does not work
correctly.
So... unless this application is just a game of solitaire, I suspect that
there are things your customers will need to know in order to use the
software. Document those...
RoboHelp for FrameMaker is a NEW online publishing tool for FrameMaker that
lets you easily single-source content to online Help, intranet, and Web.
The interface is designed for FrameMaker users, so there is little or no
learning curve and no macro language required! Call 800-718-4407 for
competitive pricing or view a live demo at: http://www.ehelp.com/techwr-l3
---
You are currently subscribed to techwr-l as:
archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit http://www.raycomm.com/techwhirl/ for more resources and info.
