Technical Documentation Style Guide

Technical Documentation Style Guide

KSC-DF-107 Revision F TECHNICAL DOCUMENTATION STYLE GUIDE July 8, 2017 Engineering Directorate National Aeronautics and Space Administration John F. Kennedy Space Center KSC FORM 16-12 06/95 (1.0) PREVIOUS EDITIONS MAY BE USED KDP-T-5411_Rev_Basic-1 APPROVED FOR PUBLIC RELEASE — DISTRIBUTION IS UNLIMITED KSC-DF-107 Revision F RECORD OF REVISIONS/CHANGES REV CHG LTR NO. DESCRIPTION DATE Basic issue. February 1979 Basic-1 Added Section V, Space Station Project Documentation July 1987 Format and Preparation Guidelines. A General revision incorporating Change 1. March 1988 B General revision incorporating Supplement 1 and the metric August 1995 system of measurement. C Revised all sheets to incorporate simplified document November 15, 2004 formats and align them with automatic word processing software features. D Revised to incorporate an export control sign-off on the April 6, 2005 covers of documents and to remove the revision level designation for NPR 7120.5-compliant project plans. E General revision. August 3, 2015 F General revision and editorial update. July 8, 2017 ii APPROVED FOR PUBLIC RELEASE — DISTRIBUTION IS UNLIMITED KSC-DF-107 Revision F CONTENTS 1. INTRODUCTION ............................................................................................ 1 1.1 Purpose ......................................................................................................... 1 1.2 Scope and Application.................................................................................... 1 1.3 Conventions of This Guide ............................................................................. 2 2. DOCUMENTS ................................................................................................ 2 2.1 Applicable Documents.................................................................................... 2 2.1.1 Government Documents ................................................................................ 2 2.1.2 Non-Government Documents ......................................................................... 3 2.2 Reference Documents.................................................................................... 3 2.2.1 Government Documents ................................................................................ 3 2.2.2 Non-Government Documents ......................................................................... 3 3. GENERAL CONVENTIONS FOR WRITING AND FORMATTING.................. 4 3.1 Selecting Words and Phrases ........................................................................ 4 3.2 Consistency and Accuracy of Terms .............................................................. 4 3.3 Voice and Mood ............................................................................................. 5 3.4 Shall, Should, Will, and Must .......................................................................... 5 3.5 Abbreviations ................................................................................................. 6 3.5.1 Types of Abbreviations ................................................................................... 6 3.5.2 Use of Abbreviations ...................................................................................... 7 3.5.3 Abbreviations Not Called Out ......................................................................... 7 3.5.4 Plurals of Abbreviations .................................................................................. 8 3.5.5 Possessives of Abbreviations ......................................................................... 8 3.5.6 Articles with Abbreviations ............................................................................. 8 3.5.6.1 Definite Article ................................................................................................ 8 3.5.6.2 Indefinite Articles ............................................................................................ 9 3.5.7 Periods, Spaces, and Mixed Cases with Abbreviations .................................. 9 3.6 Contractions ................................................................................................. 10 3.7 Pronouns...................................................................................................... 10 3.7.1 Use of Pronouns .......................................................................................... 10 3.7.2 Problems with Pronouns and Gender ........................................................... 11 3.8 Attributive Nouns .......................................................................................... 11 3.8.1 Excessive Consecutive Nouns ..................................................................... 11 3.8.2 Singular vs. Plural Attributive Nouns ............................................................ 12 3.9 Compound Words and Phrases ................................................................... 12 3.9.1 Compound Nouns ........................................................................................ 12 3.9.1.1 Nouns Combined with Adverbs .................................................................... 12 3.9.1.2 Process Nouns ............................................................................................. 13 3.9.1.3 Phrasal Nouns ............................................................................................. 13 3.9.2 Compound Verbs ......................................................................................... 13 3.9.3 Compound Adjectives .................................................................................. 14 3.9.4 Prefixes and Suffixes ................................................................................... 17 3.9.5 Suspending Hyphens ................................................................................... 18 3.10 Items in a Series .......................................................................................... 19 3.10.1 Simple Items ................................................................................................ 19 3.10.2 Complex Items ............................................................................................. 19 APPROVED FOR PUBLIC RELEASE — DISTRIBUTION IS UNLIMITED iii KSC-DF-107 Revision F 3.10.3 Inconsistently Modified Items ....................................................................... 20 3.10.4 Appositives in Items ..................................................................................... 21 3.11 Parallel Construction .................................................................................... 22 3.11.1 Parallel Grammatical Expression ................................................................. 22 3.11.2 Parallel Visual Arrangement ......................................................................... 22 3.11.2.1 Items in Running Paragraphs ....................................................................... 23 3.11.2.2 Outline Structure of Bulleted or Enumerated Lists ........................................ 23 3.11.2.3 Grammatical Structure of Bulleted or Enumerated Lists ............................... 25 3.12 Casing .......................................................................................................... 26 3.12.1 Sentence Case ............................................................................................ 26 3.12.2 Title Case ..................................................................................................... 27 3.13 Proprietary Names ....................................................................................... 28 3.14 E-Mail Addresses ......................................................................................... 28 3.15 Website Addresses ...................................................................................... 29 3.16 Numbers ...................................................................................................... 29 3.16.1 Countable Quantities .................................................................................... 29 3.16.2 Measured Quantities .................................................................................... 31 3.16.3 Fractions ...................................................................................................... 33 3.16.4 Percentages ................................................................................................. 34 3.16.5 Money .......................................................................................................... 35 3.16.6 Mathematical or Chemical Expressions in Running Text .............................. 35 3.16.7 Display Equations ........................................................................................ 36 3.16.8 Dates ........................................................................................................... 37 3.16.9 Ordinal Numbers .......................................................................................... 38 3.17 Figures and Their Titles ................................................................................ 38 3.18 Tables and Their Titles ................................................................................. 41 3.19 Writing and Formatting Definitions ............................................................... 44 3.20 Warnings, Cautions, and Notes .................................................................... 45 3.21 Treatment of Computer Interfaces ................................................................ 46 3.21.1 Screenshots ................................................................................................

View Full Text

Details

  • File Type
    pdf
  • Upload Time
    -
  • Content Languages
    English
  • Upload User
    Anonymous/Not logged-in
  • File Pages
    132 Page
  • File Size
    -

Download

Channel Download Status
Express Download Enable

Copyright

We respect the copyrights and intellectual property rights of all users. All uploaded documents are either original works of the uploader or authorized works of the rightful owners.

  • Not to be reproduced or distributed without explicit permission.
  • Not used for commercial purposes outside of approved use cases.
  • Not used to infringe on the rights of the original creators.
  • If you believe any content infringes your copyright, please contact us immediately.

Support

For help with questions, suggestions, or problems, please contact us