Re: Thinking like a user, or sticking to tried and true?

["Harris, Michael" <Michael -dot- Harris -at- innocon -dot- com>]

David Castro wrote:

"I am working on a short document that is going to be used to train
some network technicians on how to copy settings from one router to
another." 


Before becoming a technical writer years ago, I was an electronics technician in both the military and private sector, and even worked as a 'slot tech' maintaining  slot machines and network systems in that arena.  As a technical writer, among other things, I have written about radar-based aircraft landing systems, submarine-based missile systems, complex flight simulators and even wrote literally hundreds of procedures for the casino industry.  I could effectively communicate with people with a wide range of educational levels.  

I said all that to say this...  You said that you were writing a short document.  I agree with several responses about writing for any potential reader, and am in favor of writing the Overview, regardless of what you display as the section heading.  If your document walks through a short procedure, consider creating a version as a small, hard-plastic card, or even thick card-stock that can be easily printed on a laser printer, which the technician can carry in this or her pocket.  It can be ISO-9000 approved and assigned a document number just like any other formal document, but is short, sweet and to the point.

Respectfully,

Michael "It's my job to make you look good" Harris

Michael B. Harris
Technical Writer
Innovative Concepts, Inc.        
8200 Greensboro Drive, Suite 700   
McLean, Virginia, 22102  USA        
Office: (703) 893-2007, X510
Fax: (703) 893-5890
michael -dot- harris -at- innocon -dot- com
http://www.innocon.com <http://www.innocon.com/> 



^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

WebWorks ePublisher Pro for Word features support for every major Help
format plus PDF, HTML and more. Flexible, precise, and efficient content
delivery. Try it today! http://www.webworks.com/techwr-l

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

---
You are currently subscribed to TECHWR-L as archive -at- infoinfocus -dot- com -dot- 

To unsubscribe send a blank email to
techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit http://lists.techwr-l.com/mailman/options/techwr-l/archive%40infoinfocus.com


To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com

Send administrative questions to admin -at- techwr-l -dot- com -dot-  Visit
http://www.techwr-l.com/techwhirl/ for more resources and info.