TechWhirl Sponsors

---

 

[Author Prev][Author Next][Thread Prev][Thread Next]
[Author Index (this month)][Thread Index (this month)][Top of Archive]

Re: What goes in admin guide vs ops guide vs user's guide...

Subject: Re: What goes in admin guide vs ops guide vs user's guide...
From: Jan Henning <henning -at- r-l -dot- de>
To: TECHWR-L <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Wed, 13 Aug 2003 07:22:45 +0200

I'm looking for guidelines other people have developed for how to divide
content between different documents.

That would depend on the document sets and the information needing to be dcoumented.

You should start with an audience analysis: Who will be using your documentation? For what? Are there distinct audience groups or roles?

Then define the document set: What documents are needed/useful to allow the users to do what they need to do? Write a brief definition for each document of the purpose it serves.

When you have that, deciding which information eeds to go in which document should be comparatively easy. (Keep in mind, though, that some information will belong in several documents.)

Hope this helps
Jan Henning

--------------------------------------------------------------------
Jan Henning
ROSEMANN & LAURIDSEN GMBH
Am Schlossberg 14, D-82547 Eurasburg, Germany

Phone: +49 700 0200 0700, Fax: +49 8179 9307-12
E-Mail: henning -at- r-l -dot- de, Web: www.r-l.de
--------------------------------------------------------------------

---

References:
What goes in admin guide vs ops guide vs user's guide...: From: Kate Robinson

Previous by Author: Re: Deleting a row in a FrameMaker table - Thanks
Next by Author: Re: Need GIMP, dunno how to compile
Previous by Thread: Re: What goes in admin guide vs ops guide vs user's guide...
Next by Thread: Another tragic case of not reading the manual

[Top of Archive] | [Author Index (this month)] | [Thread Index (this month)]

---

---

---