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.
Thinking like a user, or sticking to tried and true?
Subject:Thinking like a user, or sticking to tried and true? From:"David Castro" <thejavaguy -at- gmail -dot- com> To:TECHWR-L <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Thu, 21 Dec 2006 06:32:17 -0500
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. The documents that this document was based on have had an
overview section at the beginning. The document that was delivered to
me to edit & format didn't have any content in this section, but I
could fairly easily create content based on the rest of the document.
However, in thinking about what my users are like (my SMEs are also
net techs), I realize that they're going to immediately skip the
overview and jump right into the nitty gritty. So, the question is
whether to think like a user and leave off the overview, or create one
because "there's always been one" and because "it's good practice to
start by telling them what you're going to tell them and end with
telling them what you told them."
Which do you do when you're faced with this decision? And why?
--
-David Castro
thejavaguy -at- gmail -dot- 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