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.
First, I am constrained by Department of Defense (DOD) standards in
formatting my documents. I must usually follow the format specified in
a Data Item Description (DID) that is associated with a particular
document. This is probably a good thing because I don't have a
creative bone in my body.
Second, the following is an excerpt from DID DI-MCCR-80025A, which
provides the format of a Software Requirements Specification (SRS):
10.1.8 Notes. This section shall be numbered 6 and shall
contain any general information that aids in understanding
this specification (e.g., background information, glossary,
formula derivations). This section shall include an
alphabetical listing of all acronyms, abbreviations, and
their meanings as used in this document.
Third, I organize Section 6 as follows:
6.1 Acronyms and abbreviations
DID Data Item Description
DOD Department of Defense
SRS Software Requirements Specification
Department of Defense. A large organization based in
Washington, DC that is famous for its ability to create
Fourth, I leave a lot of space between the acronyms and their terms
because I must always deal with things like "COMNAVAIRSYSCOM."
Fifth, I always provide the acronym on the first occurrence of the
defining term in the text.
Sixth, I don't understand why the last four terms in Jane's list are in
a list of acronyms.