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:"Granny" instructions From:Krista van Laan <vanlaan -at- BILBO -dot- NTC -dot- NOKIA -dot- COM> Date:Fri, 14 Nov 1997 12:11:19 +0200
I was asked to produce some idiot-proof instructions for procedures
that I thought were already documented fairly comprehensively.
I find that I'm not very confident about how much to
include. The customer seems to want _everything_ included -- they
even asked me to spell out all abbreviations and acronyms, even
though abbreviations are used in the menus and windows. (This does
not strike me as a simplification, but it indicates that they want
everything down to the nth detail.)
So sometimes I feel as if I'm describing much too much
(and therefore including a lot of text that will confuse and
eventually bore the user) and other times possibly not enough.
I'm concerned that the procedures will be much too long. I really
dislike seeing 20- or 30-step procedures.
An influencing factor is that the users are not native English speakers,
which may account for some of the difficulties they've had in trying
to follow the existing procedures.
Any thoughts or ideas on this subject? Aside from using clear and
simple English, which of course I'm trying to do.
========================================================================
Krista Van Laan Phone: 358 9 511 23684
Nokia Telecommunications Oy Fax: 358 9 511 23554
P.O. Box 320 Email: krista -dot- vanlaan -at- ntc -dot- nokia -dot- com
FIN-00045 NOKIA GROUP Finland Office: Hiomotie 5 FIN-00380 Helsinki