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: Asking for help in designing a new document From:Stuart Burnfield <slb -at- westnet -dot- com -dot- au> To:techwr-l -at- lists -dot- techwr-l -dot- com Date:Fri, 28 Jul 2006 21:56:15 +0800
A good way to simplify your task is to briefly state your assumptions
about the sort of person you're writing for. For example, are you
assuming that the reader will be a DBA? How much experience? UNIX
background? System admin experience? Oracle experience?
This will help you to document in an even way (not over-explaining in
one topic and over-assuming in another).
For example, you might state that your run book assumes DBA experience,
preferably with Oracle, and basic UNIX sysadmin experience. If the
apre-bus DBA happens to lack experience in one of these areas, at least
you're giving them a head start on the sort of knowledge they need to
brush up on so that they can get the most out of the run book.
Good luck.
Stuart
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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
Doc-To-Help includes a one-click RoboHelp project converter. It's that easy. Watch the demo at http://www.DocToHelp.com/TechwrlList