RE: Asking for help in designing a new document

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

---
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 lisa -at- techwr-l -dot- com -dot- Visit
http://www.techwr-l.com/techwhirl/ for more resources and info.


Previous by Author: Re: OT: Wikipedia as a reference source
Next by Author: Re: Survey Question
Previous by Thread: RE: Asking for help in designing a new document
Next by Thread: RE: Asking for help in designing a new document


What this post helpful? Share it with friends and colleagues:


Sponsored Ads