RE: documentation plan?

Subject: RE: documentation plan?
From: "krupp, marguerite" <krupp_marguerite -at- emc -dot- com>
To: TECHWR-L <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Mon, 5 Jun 2000 12:16:58 -0400

The similarity in terminology is confusing. And people use the terms not
only interchangeably, but to mean the reverse of what other people mean by
the same terms. (Whew!)

In my book, a doc specification describes a single document. Kelly Parr has
given a good synopsis of the contents of a doc spec.

A doc PLAN, OTOH, is an overview-level specification for an entire doc set.
It does not go into the detail for each document. Rather, it lists all the
doc deliverables and includes a blurb about each. Typically, a project
leader would do the doc plan before the individual writers did the doc

If you're interested, I have a little writeup that I give out to my students
about the differences. And do keep in mind that what I call a doc plan
others call a doc spec.


-----Original Message-----
From: skwpt [mailto:skwpt -at- yahoo -dot- com]
Sent: Monday, June 05, 2000 12:02 PM
Subject: Re: documentation plan?

> --- "Jessica N. Lange" <jlange -at- oee -dot- com> wrote:
> ...."documentation plan". Can someone explain
> to me what this is...

Previous by Author: Re: inifinitive phrases/colons & lists
Next by Author: RE: Editing Guides
Previous by Thread: Re: documentation plan?
Next by Thread: Re: documentation plan?

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

Sponsored Ads