ML20041E043
| ML20041E043 | |
| Person / Time | |
|---|---|
| Issue date: | 02/28/1982 |
| From: | NRC OFFICE OF ADMINISTRATION (ADM) |
| To: | |
| References | |
| NUREG-0650, NUREG-0650-S01, NUREG-650, NUREG-650-S1, NUDOCS 8203100012 | |
| Download: ML20041E043 (17) | |
Text
,
NUREG-0650 Supplement No.1
~
Technical Writing Style Guide An,-\\lternative Reference System for NRC Publications l
U.S. Nuclear Regulatory Commission Office of Administration p" "c ooq I'i
' 'i 2
i6 O '-
g s,.,,,,/
o i
1 88 A8Rea" 2 2""
0650 R PDR
NOTICE Availability of Reference Materials Cited in NRC Publications Most documents cited in NRC publications will be available from one of the following sources:
- 1. The NRC Public Document Room,1717 H Street, N.W.
WashirW.on, DC 20555
- 2. The NRC/GPO Sales Program, U.S. Nuclear Regulatory Commission, Washington, DC 20555
- 3. The National Technical Information Service, Springfield, VA 22161 t*
Although the listing that follows represents the majority of documents cited m NRC publications, it is not intended to be exhaustive.
Referenced documents available for inspection and copying for a fee from the NRC Public Docu-ment Room include NRC correspondence and internal NRC memoranda; NRC Of fice of Inspection and Enforcement bulletins, circulars, information notices, inspection and investigation notices; Licensee Event Reports; vendor reports and correspondence; Commission papers;and applicant and licensee documents and correspondence.
The following documents in the NUREG series are available for purchase from the NRC/GPO Sales i
Program: formal NRC staff and contractor reports, NRC sponsored conference proceedings, and NRC booklets and brochures. Also available are Regulatory Guides, NRC regulations in the Code o/
Federal Regulations, and Nuclear Regulatory Commission issuances.
Documents available from the National Technical Information Service include NUREG series reports and technical reports prepared by other federal agencies and reports prepared by the Atomic Energy Commission, forerunner agency to the Nuclear Regulatory, Commission.
Documents available from public and special technical libraries include all open literature items, such as books, journal and periodical articles, and transactions. Federal Register r'otices, federal and state legislation, and congressional reports can usually be obtained from these libraries.
Documents such as theses, dissertations, foreign reports and translations,and non NRC conference proceedings are available for purchase from the organization sponsoring the publication cited.
Single copies of NRC draf t reports are asailab:e free upon written request to the Division of Tech-nical Information and Document Control, U.S. Nuclear Regulatory Commission, Washington, DC 20555.
Copies of industry codes and standards used in a substantive manner in the NHC regulatory process are maintained at the NRC Library, 7920 Norfolk Avenue, Bethesda, Maryland, and are available there for reference use by the public. Codes and s'andards are usually copyrighted and may be purchased from the originating organization or, if they are American National Standards, from the American National Standards Institute,1430 Broadway, New York, NY 10018.
M GPO Printmt r.$py price: $2.25 k
NUREG-0650 Supplement No.1 l
Technical Writing Style Guide
'S An Alternative Reference System for NRC Publications Date Published: February 1982 Division of Technical Information and Docisment Control Office of Administration U.S. Nuclear Regulatory Commission Washington, D.C. 20555
?,
I d
e
\\v'
l ABSTRACT I
This supplement to the U.S. Nuclear Regulatory Commission (NRC) " Technical Writing Style Guide" (NUREG-0650) provides an alternative system for referencing documents in NRC publications.
Instead of being listed according to the order in which they first appear in the text of a report, references in this alter-j native system are grouped into categories by types of documents referenced.
This supplement also updates information on referencing classified and proprietary material and provides guidance on how to cite codes and standards in NRC publications.
P
CONTENTS PaSe ABSTRACT.............................................................
iii PREFACE.............................................................
vii i
1.
INTRODUCTION....................................................
1 2.
GROUPING BY TYPE OF REFERENCE...................................
I 2.1 Citing References in Text..................................
3
- 2. 2 Sample Document Categories and Formats.....................
4 2.2.1 Applicant / Licensee Documents.......................
4 2.2.2 Books..............................................
4 2.2.3 Commission Papers..................................
5 2.2.4 Conference Proceeding Papers.......................
5 2.2.5 Congressional Reports..............................
5 2.2.6 Correspondence and Memoranda.......................
5 2.2.7 Federal Register Notices...........................
6 2.2.8 Foreign Reports....................................
6 2.2.9 Inspection and Enforcement Documents...............
6 2.2.10 Journal Articles...................................
6 2.2.11 Meetings...........................................
7 2.2.32 NUREG Reports......................................
7 2.2.13 Other Federal Agency Publications.................
7 2.2.14 Other Documents....................................
8 2.2.15 Theses and Dissertations...........................
8 2.2.16 Trip Reports.......................................
8 2.2.17 Vendor Reports.....................................
8 3.
REFERENCES TO CLASSIFIED AND PROPRIETARY MATERIAL................
8 3.1 Classified Information...............................,.....
9 3.2 Proprietary Information.......................
9 4.
REFERENCING CODES AND STANDARDS.................................
9 U
4.1 Format for Codes and Standards Refarences..................
9 4.2 Availability Statement....................................
10 v
d e
4 PREFACE This supplement to the NRC " Technical Writing Style Guide" (NUREG-0650) provides new guidelines for citing references in NRC reports.
These new guide-lines supplement the existing system with a method that will more easily allow for the insertion or deletion of references in NRC reports, particularly large multiple-author reports that require expedited handling.
Please note, how-ever, that use of this alternative reference system described here is suggested rather than mandatory.
Reference coverage also now includes guidance on how to cite codes and stand-ards.
This guidance reflects NRC policy that codes and standards used in a substantive manner during the regulatory process be systematically identified, indexed, and filed for staff and public availability at the NRC technical library.
Should you require assistance in implementing these reference guidelines, please call the Division of Technical Information and Document Control at ext. 27608 and ask for an editor.
Policy and Publications Management Branch Division of Technical Information and Document Control 7
)
vii 1
j
9 Technical Writing Style Guide:
An Alternative Reference System for NRC Publications 3.
INTRODUCTION At present, references in NRC publications are usually arranged in numerical sequence according to the order in which they first appear in text.
Thus, in 1
text, the number one either in parentheses (Ref. 1), or as a superscript,
refers the reader to the first reference citation in the reference list that appears either at the end of each chapter in long reports or at the conclusion of brief reports.
Although in widespread use, this system creates a number of problems, especially for large reports requiring quick turnaround and reports l
with multiple authors.
Both kinds of reports account for a large percentage cf NRC staff NUREG publications. When a new reference is added or a reference is deleted in the late stages of manuscript preparation, a ripple ef fect is created throughout the manuscript in that all the other references must be renumbered in a new sequence to accommodate the change.
The procedure of resequencing references is not only time consuming and therefore costly to the Agency, but also opens up the possibility that errors will occur.
It is all too easy for an author or editor to miss a reference and thus have the entire reference list incorrect beyond the point at which the error occurs.
Changes that require references to be resequenced also increase the ri'sk that errors will occur as material is retyped.
One way to avoid renumbering report references is to wait until the final version of the report to number them.
While writing the first and subsequent drafts, insert the appropriate citations into the text in parentheses or brackets, using the author and date, title and date, or any other appropriate information.
These notes can then be converted to a numbered system in the final draft, when the content of the report will undergo no further changes.
Should that method not be feasible, this supplement suggests an alternative of citing references that should help authors, editors, and word processors avoid the pitfalls of resequencing references.
In addition, this supplement also provides detailed guidance on citing codes and standards and further clarifies how to reference classified and proprietary information.
Finally, regardless of which reference system is used, the Notice on the following page, which appears on the inside cover of each staff NUREG report, announces the public availability of documents cited in NRC reports.
Information about the availability of documents cited, therefore, need not appear in the reference sections of staff NUREG reports.
2.
GROUPING BY TYPE OF REFERENCE To entirely eliminate the need for numbering references, group them into separate categories in the reference section according to the types of 1
i NOTICE Availability of Reference Materials Cited in NRC Publications Most documents cited in NRC publications will be available from one of the following sources:
- 1. The NRC Public Document Room,1717 H Street, N.W.
Washington, DC 20555
- 2. The N RC/GPO Sales Program, U.S. Nuclear Regulatory Commission, Washington, DC 20555 I
- 3. The National Technical Information Service, Springfield, VA 22161 Although the listing that follows represents the majority of documents cited in NRC publications, it is not intended to be exhaustive.
Referenced documents available for inspection and copying for a fee from the NRC Public Docu-ment Room include NRC correspondence and internal NRC memoranda; NRC Office of Inspection and Enforcement bulletins, circulars, information notices, inspection and investigation notices; Licensee Event Reports; vendor reports and correspondence; Commission papers; and applicant and licensee documents and correspondence.
The follomng documents in the NUREG series are available for purchase from the NRC/GPO Sales Program: formal NRC staff and contractor reports, NRC-sponsored conference proceedings, and NRC booklets and brochures. Also available are Regulatory Guides, NRC regulations in the Code of Federal Regulations, and Nuclear Regulatory Commission Issuances.
Documents available from the National Technical Information Service include NUREG series reports and technical reports prepared by other federal agencies and reports prepared by the Atomic Energy Commission, forerunner agency to the Nuclear Regulatory Commission.
Documents available from public and special technical libraries include all open literature items, such as books, journal and periodical articles, and transactions. Federal Register notices, federal and state legislation, and congressional reports can usually be obtained from these libraries.
Documents such as theses, dissertations, foreign reports and translations, and non-NRC conference proceedings are available for purchase from the organization sponsoring the publication cited.
Single copies of NRC draft reports are available free upon written request to the Division of Tech-r nical Information and Document Control, U.S. Nuclear Regulatory Commission, Washingten, DC 20555.
Copies of industry codes and standards used in a substantive manner in the NRC regulatory process are maintained at the NRC Library, 7920 Norfolk Avenue, Bethesda, Maryland, and are available there for reference use by the public. Codes and standards are usually copyrighted and may be purchased from the originating organization or, if they are American National Standards, from the American National Standards Institute,1430 Broadway, New York, NY 10018.
2 I
- ---- - J
documents referenced:
NUREG reports, corres'pondence, licensee documents, codes and standards, and the like.
Under this system, all references are gathered together in a separate reference section and each category of document is identified by an appropriate heading.
Section 2.2 of this supplement lists characteristic documents and provides a sample format for each.
2.1 Citing References in Text Instead of references being numbered in text, information about each appears in parentheses where the number would otherwise appear.
The information cited varies according to the type of document being referenced:
the identification number for codes and standards; the report number for reports so identified; the author's name for books, journal articles, conference proceeding papers, correspondence and memoranda.
This system succeeds only if the format for the in-text references corresponds to the format of the reference section.
For example, a letter referenced in text by author (J. G. Doe, NUS) should not appear in the reference list as
" October 20, 1981, Letter from J. G. Doe, NUS, to L. P. Roe, NRC, Subject...."
Instead, the entry in the reference section for this letter should begin with the sender's name and be followed by the other pertinent information.
As a general rule, give enough information in the text citation so that the reader can locate the entry in the reference list without difficulty.
Other guidelines for in-text references:
o If the work cited has more than one author, include only the name of the first author, last name first, and then initials.
(Doe, J. P.)
o If the reference list includes two or more authors with the same name, include their initials to avoid confusion.
(Smith, L. G.)
(Smith, A. R.)
o If one author has written more than one publication on a reference list, include the date of the publication cited following the name.
If the author and year are identical for more than one reference, insert lowercase letters in alphabetical order after the year.
(Dawson, 1976 a)
(Dawson, 1976 b), etc.
o Cite a particular page, chapter, figure, table, or equation in the text rather than in the reference list.
(NUREG-0683, Vol. 2, Appendix K) 3 bu
l o
Try to limit multiple references at one point in the text.
If not possible, arrange the citations in parentheses in the order they appear in the reference section by category separated by semicolons.
(Atkinson, 1980; NUREG-0262; NUREG/CR-0983; Regulatory Guide 1.71)
To avoid unduly lengthy references in text, list multiple citations that extend longer than one line in a footnote.
One further advantage of citing references in text is that not all material referenced need appear in the reference section.
In particular, references to Regulatory Guides and the Code of Federal Regulations can be cited solely in text.
For Regulatory Guides, the Regulatory Guide number and title provide sufficient information for the reader to identify the Guide cited and to obtain it using the availability statement on the inside cover of all staff NUREG reports (see p. 2).
Similarly, references to the Code of Federal Requiations are sufficient in text if they include the part number and any appendix cited.
2.2 Sample Document Categories and Formats The following list contains those categories of documents typically referenced in NRC staff reports.
Following the title of each category are suggested examples of how to format that type of document, as well as suggested infor-mation on how to sequence the references within each document category.
Please note that the document categories themselves can be sequenced in a number of ways.
They may be ordered by frequency of occurrence.
For example, if correspondence makes up the majority of references, that category could be listed first, followed by the second most frequently cited type of document, then the third, and so on.
On the other hand, the categories may be arranged alphabetically, aJ in the listing that follows.
Finally, you may be able to arrange all references in a single alphabetically arranged list, provided that all citations on the list can be alphabetizea by author, title, or report or other alphanumeric code.
Whatever its order, the listing should be arranged with the reader's ease of use in miad.
2.2.1 Applicant / Licensee Documents (Arrange alphabetically by title.)
Format:
Title, Project or docket number, Date.
Example:
" Preliminary Safety Analysis Report, Nuclear Fuel Recovery and Recycling Center," Docket 50-564, June 1976.
2.2.2 Books (Arrange alphabetically by authors' last names.)
Format:
Author (s), Title, Edition and/or volume, City:
Publisher, Year of publication, page numbers.
4
Example:
Lewis, B. and J. Von Elbe, Combustion, Flames, and Explosions of Gases, 2nd ed., New York, Academic Press, 1961.
2.2.3 Commission Papers (Arrange in SECY-number order.)
Format:
SECY number, Subject, Date.
I Example:
1 SECY-81-422, " Proposed Rule:
TMI-Related Requirements for Operating Reactors," July 15, 1981.
2.2.4 Conference Proceeding Papers (Arrange alphabetically by authors' last names.)
Format:
Author (s), Paper title, Proceeding title, Report number (if any),
Date proceeding published.
Example:
Dhir, V. K. and I. Catton, " Prediction of Dryout Heat Fluxes in Beds of Volumetrically Heated Particles," in Proceedings of the International Meeting on Fast Reactor Safety and Related Physics, Vol. 4, COMF-761001, February 1977.
2.2.5 Congressional Reports (Arrange alphabetically by title.)
Format:
Title, Originating organization, Date.
Example:
" Nuclear Power Costs," 23rd Report by the Committee on Government Operations, U.S. House of Representatives, April 26, 1978.
2.2.6 Correspondence and Memoranda (Arrange alphabetically by sender's last name.)
Format:
Sender and organization, Receiver and organization, Subject, Docket or project number (if appropriate), date.
5
Example:
Weisenberg, M. R., TVA, to E. Adensam, NRC,
Subject:
" Forwards description of vent design in response to item II.B.1 of NUREG-0737," July 1, 1980.
2.2.7 Federal Register Notices (Arrange sequentially by volume and issue numbers.)
Format:
Volume number, Federal Register (abbreviated), Issue number, Title I
of notice, Issuing organization, Page(s), Date.
Example:
46 FR 144 " Memorandum of Understanding Between the Nuclear Regulatory Commission and Department of Energy Concerning the Remova! and Disposition of Solid Nuclear Wastes from Cleanup of the Three Mile Island Unit 2 Nuclear Plant," U.S. Nuclear Regulatory I
Commission, 38615, July 28, 1981.
2.2.8 Foreign Reports (Arrange alphabetically by authors' last names.)
Forma t:
Author (s), Title, Originating organization, Report number, Date, Availability information, i.e., organization, city and country.
Example:
Shires, G. L. and G. F. Stevens, "Dryout During Boiling in Heated Particulate Beds," United Kingdom Atomic Energy Authority, AFEV-M1779, April 1980, Winfrith Secretariat, Dorchester, England.
I 2.2.9 Inspection & Enforcement Documents (Arrange in alphanumeric order.)
Format:
Identification number, Subject, Date of issuance.
Example:
IN 81-25; "Open Equalizing Valve of Differential Pressure Transmitter Causes Reactor Scram and Loss of Redundant Safety Signals,"
August 24, 1981.
2.2.10 Journal Articles (Arrange alphabetically by au'thors' last names.)
Format:
Author (s), Title of article, Title of journal, Volume and (number),
Pages, Date.
6 l
Example:
Hardee, H. C. and R. N. Nelson, " Natural Convection in a Porous Media with Heat Generation," Nuclear Science and Engineering, 63 (12), 119-132, 1977, 2.2.11 Meetings (Arrange chronologically by dates of meetings.)
Format:
Date of meeting, Groups participating, Topic, Author of meeting summary, Author's organization, Date of summary.
Example:
February 20, 1980, NRC, Power Authority of the State of New York, Consolidated Edison, and Commonwealth Edison, " Meeting with Zion / Indian Point Utilities to discuss accident mitigation features," L. 01shan, NRC, Feb. 21, 1980.
2.2.12 NUREG Reports (Arrange in alphanumeric sequence, listing staff NUREGs first.)
Include all staff and c>ntractor reports, pamphlets and brochures in the NUREG series.
Format for Staff Reports:
NUREG number, Title, Date published.
Example:
NUREG-0721, " Acceptance Criteria for the Physical Protection Upgrade Rule Requirements for Fixed Sites," September 1980.
Format for Contractor Reports:
NUREG number, Title, Contractor, Date.
Examp1e:
NUREG/CR-1496, " Nuclear Power Plant Operating Experience - 1979, Annual Report," Oak Ridge National Laboratory, May 1981.
2.2.13 Other Federal Agency Publications (Arrange alphanumerically by report number.)
Format:
Report Number, Title, Agency, Date.
7
B Example:
00E/ET-0028,' " Technology for Commercial Radioactive Waste Management,"
U.S. Department of Energy, May 1979.
2.2.14 Other Documents (Arrangement will be determined oy contents of the section.)
Include in this section documents that do not fit into any of the other categories you have chosen.
2.2.15 Theses and Dissertations (Arrange alphabetically by authors' last names.)
Format:
Author, Title, Type of document, School, Date.
Example:
Jacobs, J.
J., " Programming Language I for the Varian PLCU,"
Master's thesis, North Carolina University, 1971.
2.2.16 Trip Reports (Arrange chronologically).
Format:
Date, Author and organization, Receiver and organization, Subject.
Example:
February 1981, A. R. Marchese, NRC, to T. P. Speis, NRC, " Report on Foreign Travel."
2.2.17 Vendor Reports (Arrange alphabetically by authors' last names.
Where more convenient, arrange by report number or alphabetically by vendor.)
Format:
Author (s), Title, Vendor, Report number, Date.
Example:
Valich, M. and M. Gooding, " Equipment Qualification Test Report -
Instrument Bus Distribution Panel (Normal and Abnormal Temperature and Humidity Testing)," Westinghouse Electric Corp., WCAP-8587-82 E19A, 9/30/80.
3.
REFERENCES TO CLASSIFIED AND PROPRIETARY MATERIAL When using nonproprietary or unclassified (or declassifiable) information that comes from proprietary or classified documents, you may make that portion of the document publicly available in one of several ways.
You may insert it in the body of the text, place it in a footnote to the text, copy and pla,cp it in 8
l
an appendix, or abstract the information and make it available for inspection and copying for a fee in the NRC Public Document Room and then cite it as a reference to the text.
Citing classified or proprietary documents is strongly discouraged.
In some instances, however, these references cannot be avoided because they are the only source for the information.
Accordingly, reference proprietary and cl'assified documents when necessary.
3.1 Classified Information I
(
Depending on the reference system used, cite the document in text either in parentheses or by reference number.
In the reference section, state " Classified
- report, Not publicly available."
If the report title and author (s) are unclassified, list them, followed by tne statement, " Classified report.
Not publicly available."
3.2 Proprietary Information Cite the information in text and list it in tne reference section.
Following the title and originating organization in the reference section, state
" Proprietary information.
Not publicly available."
4.
REFERENCING CODE 5 AND STANDARDS NRC policy, as set forth in Manual Chapter 0215, provides that codes and standards used substantively during the regulatory process be systematically identified, procured, indexed, and filed at the NRC technical library, where they will be available to NRC staff and the public.
To implement this policy, the staff must identify all codes and standards used to support NRC staff positions in NRC documents..The codes and standards cited shall appear in the reference section or bibliography of the document.
A copy of the completed document shall be sent to the Library Branch clearly marked to indicate that it is to be used for codes and standards cross referencing.
The Library staff will index and file all codes and standards so identified in a special reference file that will be available to both staff and the public.
4.1 Format for Codes and Standards References Each substantive reference to a code or standard shall include the following information:
1.
Identification number of the code or standard 2.
Name of the originating organization, if other than the American National Standards Institute 3.
Title of the code or standard 4.
Date of issuance, if not given as part of the identification number 5.
An availability statement if the code or standard is still in draft form:
"Available for inspection and copying for a fee at +.he NRC Public Document Room, 1717 H St., NW., Washington, D.C.
20555."
9
Examples:
ANSI /ANS 3.5-1981, " Nuclear Power Plant Simulators for Use in Operator Training," American National Standards Institute /
American Nuclear Society.
IEEE 279-1971, " Criteria for Protection System for Nuclear Power Generating Station," Institute of Electrical and Electronics Engineers.
For references to the Boiler and Pressure Vessel Code of the American Society of Mechanical Engineers, include the Section, Division, Subarticle, and addendum in which that subarticle appeared.
Example:
" Boiler and Pressure Vessel Code,"Section III, Division 2, Subsubarticle CC-3720, Service Load Category, Winter Addendum, 1980, American Society of Mechanical Engineers.
4.2 Availability Statement A statement announcing the public availability of codes and standards appears on the inside cover of all staff NUREG reports.
(See page 2.)
T 10
U S NUCLI AR REGUL AToRY Ct"h4 MISSION NUREG-0650 BIBLIOGRAPHIC DATA SHEET Supplement No. 1 4 TITLE AND SUBTITLE (Add Voruon* No. o! warmrostel
- 2. (Leave blaski Technical Writing Style Guide: An Alternative Reference 3 RECIPif NT'S ACCESSION NO.
System for NRC Publications
- 7. AUTHOH tSi S. DATE REPORT COMPLE TED M ON TH l YEAR January 1982 9 PE HF ORMING ORGAN 12ATION N AME AND MAILING ADDRESS (Include 20 Codel DATE HEPORT ISSUED Division of Technical Information and Document Control Mm T H lva^a Februa ry 1982 U.S. Nuclear Regulatory Commission Washington, DC 20555 6 Ite + 6'=a * /
8 (Leave Nanni
- 12. SPONSORING OHGAN12ATION N AME AND MAILING ADDRESS (tactude I,o CodeJ p
- n. CONTRACT NO.
same as 9 13 T YPE OF RE POH T PE RIOD COVE RE D flectusare deres)
Style Guide IS SUPPLE MEN TAR ( NOTES 14 (Lesve classt
- 16. ABSTR ACT (200 words or less)
This supplement to the U.S. Nuclear Regulatory Commission (NRC) " Technical Writing Style Guide" (NUREG-0650) provides an alternative system for referencing documents in NRC publications.
Instead of being listed according to the order in which they first appear in the text of a report, references in this alter-native system are grouped into categories by types of documents referenced.
This supplement also updates information on referencing classified and proprietary material and provides guidance on how to cite codes and standards in NRC publications.
I i
17 KE Y WORDS AND DOCUMENT AN ALYSIS 17a DE SCRIPTORS i 7n IDEN TtFIE RS: OPE N E N DE D TERY5 18 AV AIL ABILtTY ST A TEVE N T 19 SE CUHI T Y CL ASS IThr I22z O
m
-i 4:rm O
E o i m
m m
CI3 33 CDm
_