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.
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:"Bonnie Granat" <bgranat -at- editors-writers -dot- info> To:"Kate Robinson" <KRobinson -at- seattle -dot- telecomsys -dot- com>, "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Tue, 12 Aug 2003 17:07:59 -0400
----- Original Message -----
From: "Kate Robinson" <KRobinson -at- seattle -dot- telecomsys -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Sent: August 12, 2003 04:56 PM
Subject: What goes in admin guide vs ops guide vs user's guide...
>
> I'm looking for guidelines other people have developed for how to divide
> content between different documents.
>
> As an example, one of the products in my group has this standard set of
> docs:
> * Administration Guide
> * Deployment Guide: Hardware
> * Deployment Guide: Software
> * Feature Description
> * Operations Guide
> * Reference Guide
>
> The group currently has no guidelines for what content goes in which doc.
> That would be one of my missions. I'd love to find out what other people
> have developed!
>
What do you mean by "Operations"? What is in the "Operations Guide" now? Is it
a user guide? Because you have an admin guide, I am concluding that
"operations," which would normally mean something akin to admin tasks, must
mean it's a user guide.
But what's in these docs now?
If you want a complete set of docs for my former employer, go to http://www.editors-writers.info/editing-writingsamples.html and you can
download the whole lot (version 4 and version 3.5). There's an installation
guide, an admin guide, and a user guide. I offer these on my Web site because
they are freely available on the Internet from several locations (resellers of
the product).
The divisions are fairly self-evident:
Installation (your term seems to be "deployment"): How to get the darn thing
on your machine and running -- both hardware and software
Admin: Stuff the IT person does regularly.
User: Your term might be "operations". How to use the darn thang.
