RE: Task-oriented manuals

Subject: RE: Task-oriented manuals
From: "Hedley Finger (EPA)" <Hedley -dot- Finger -at- ericsson -dot- com -dot- au>
To: "'techwr-l -at- lists -dot- raycomm -dot- com'" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Thu, 20 Jan 2000 17:54:33 +1100

I agree with Jane. If the GUI is defined well, the reference material is
embedded in well-chosen widget labels ToolTips or WhatIs? type of
context-sensitive help. Hitting F1 in a particular window or dialogue could
open an overview topic with links to task (i.e. procedure) documentation.



Just some thoughts from the trenches: you might want to reverse
yourself about 180 degrees on the reference material online. Users
typically don't use online help (either .hlp or .htm format) to read
reference material. If delivery is the problem, could you deliver
reference guide as a pdf on a CD? Or from your website? That would
allow the users to print it or to read it online....up to them. It
would also reduce your weight and production effort.

As for the books you mentioned, check out the John Wiley Publishers
web site (
). They publish the Technical Communication Library series and have
some excellent offerings. I remember a couple by William Horton as
well as some other well-known writers.

Jane Bergen

Hedley Finger Technical Writer

Ericsson Australia Pty Ltd
Voice Over Internet Protocol (VoIP) Project
Level 34.31 Melbourne Central Tower
360 Elizabeth Street Melbourne VIC 3000 Australia
Tel. +61 3 9301 6214 Cell. +61 412 461 558 Fax. +61 3 9301 6199
Email. hedley -dot- finger -at- ericsson -dot- com -dot- au

Hand Holding Projects Pty Ltd
28 Regent Street Burwood VIC 3125 Australia
Tel. +61 3 9809 1229 Cell. +61 412 461 558 Fax. +61 3 9809 1326
Email. hfinger -at- handholding -dot- com -dot- au

Previous by Author: RE: Vugraph? Viewgraph?
Next by Author: RE: Correct verb/infinitive for performing actions
Previous by Thread: Re: Task-oriented manuals
Next by Thread: Re: Task-oriented manuals

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

Sponsored Ads