Asking for help in designing a new document

Stuart Burnfield slb at westnet.com.au
Fri Jul 28 07:56:15 MDT 2006


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



More information about the TECHWR-L mailing list