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: "Granny" instructions again From:DURL <durl -at- BUFFNET -dot- NET> Date:Fri, 14 Nov 1997 11:12:02 -0500
I hope you're getting paid by the hour!!!
I think I'd start to think about categorizing the info, and then
matching a format style to the category of information.
For example, use a number to identify a sequential step.
Use a symbol of some kind to show anticipated result
Use another symbol or format to indicate what to do if the
anticipated result doesn't show.
Use bold for Drop Dead Important information
Use a box for explanatory information.
What you're doing, ideally, is a sort of classical conditioning,
where your
user learns to assoociate a certain category of info with a particular
look. It can help the user locate the info that meets his particular
needs.
I'm including a sort of example. Pls bear in mind, of course, that
you'll have to figure out what categories work for your document...I'm
guessing here.
1. Do this
+++ Check that X occurs
+++ Check that Y occurs
[If y doesn't occur, then]
IT'S VERY IMPORTANT THAT YOU DO THIS.
The trick will be to not develop too many categories. You might
want to look at textbooks and instructional info for ideas.
Good luck,
mary
Mary Durlak Erie Documentation Inc.
East Aurora, New York (near Buffalo)
durl -at- buffnet -dot- net
On Fri, 14 Nov 1997, Krista van Laan wrote:
> I forgot to write in my previous request for any new thoughts on writing
> minutely detailed instructions, that the customer also asked that I make
> no references to any other page, chapter, document, etc. There are
> many many procedures, with many repetitions, which is why I dread
> inundating the user with pages full of the same old stuff. Does this
> add clarity? Or detract from it? What is the middle ground? On-line
> help would be great in this situation, but it is not an option right now.
>
> From ??? -at- ??? Sun Jan 00 00:00:00 0000
> 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
>
>
> If it's about technical communication--post it! If not, don't!
> Posts: mailto:techwr-l -at- listserv -dot- okstate -dot- edu
> Commands: mailto:listserv -at- listserv -dot- okstate -dot- edu (e.g. SIGNOFF TECHWR-L)
> Archives: http://listserv.okstate.edu/archives/techwr-l.html,
> Subjects: JOB:, QUESTION:, SUMMARY:, ANNOUNCE:, or none of these.
>
>