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.
Subject:Re: Numbering From:Beverly Parks <bparks -at- HUACHUCA-EMH1 -dot- ARMY -dot- MIL> Date:Mon, 30 Oct 1995 06:30:47 MST
Apparently, not all Data Item Descriptions (DID) are created
equal. Loren said
> A simple way to satisfy everybody is to write a paragraph like this:
> 2.2 Non-Government documents. None.
> I would do this only if I had to provide a paragraph 2.3 to satisfy a
> requirement in the DID.
I'm looking at a DID for a software requirements specification
and an item in block 10 under Content and Format Instructions,
says
"In the event that a paragraph or subparagraph has been tailored
out, a statement to that effect shall be added directly
following the heading of each such (sub)paragraph. If a
paragraph and all of its subparagraphs are tailored out, only
the highest level paragraph heading need be included."
This particular DID has an approval date of 880229; I have no
idea if it's still current. The point is, however, that
government documentation is sorely inconsistent and we can't
generalize a rule based on a single, "typical" DID.
Bev Parks
bparks -at- huachuca-emh1 -dot- army -dot- mil
=============
Here's the rest of Loren's message:
Loren Castro <lfc -at- SOL -dot- CHINALAKE -dot- NAVY -dot- MIL> wrote-->
(...background snipped...)
> I'll provide an example from real life.
> A typical Data Item Description (DID) for DOD-STD-2167A (titled
> "Defense System Software Development") requires a Section 2 for
> listing references:
> Applicable documents. This section shall be numbered 2
> and shall be divided into the following paragraphs.
> Government documents. This paragraph shall be numbered 2.1.
> <details deleted>
> Non-Government documents. This paragraph shall be numbered
> 2.2 . . . . <details deleted>
> The DID does not require text under the section heading, and I supply
> none. And being small minded and an extremist for consistency, I don't
> write text under any other section headings.
> If I don't refer to any "non-Government documents" in the document I'm
> writing, I don't need a paragraph 2.2. But if I refer to "Government
> documents, I still need a paragraph 2.1. The DID requires it.
> A simple way to satisfy everybody is to write a paragraph like this:
> 2.2 Non-Government documents. None.
> I would do this only if I had to provide a paragraph 2.3 to satisfy a
> requirement in the DID.
> Well, that's my story, and I'm stuck with it. It's a different world
> here.
> lfc -at- sol -dot- chinalake -dot- navy -dot- mil
