Page 2 - Company Writer's Guide; Verbose-ese Equivalent
Company Writer's Guide [For Illustration Only] 1-2 Table 1.1-1. Examples of Wordiness Verbose-ese Equivalent by means of by connect together connect, join consider all factors carefully consider due to the fact that because for the purpose of for, to furthermore it would seem and give proper conside...
Page 3 - Verb Tenses; Use active voice to raise impact. Examples include:; Additional Guidance
Company Writer's Guide [For Illustration Only] 1-3 3. Make sure that your graphics clearly support information in the text. Have you chosen the most illustrative graphics in each section? Is there a difficult passage of text that you could elucidate with a figure? Verb Tenses As a general rule, use ...
Page 4 - Be assertive in your writing. Examples include:
Company Writer's Guide [For Illustration Only] 1-4 3. Be assertive in your writing. Examples include: • Use “will” not “may,” “plan to,” or “would.” Use “plan” only as a noun or in the strict sense of planning and scheduling. • Use “shall” only in discussing project or regulatory requirements. • Use...
Page 6 - PUNCTUATION
Company Writer's Guide [For Illustration Only] 1-6 1.3 PUNCTUATION Standard rules of English (as defined by Strunk and White 1 ) for grammar and punctuation should be used. Avoid long sentences; use semicolons (;) only in short sentences. Also, avoid using contractions because they often cause confu...
Page 7 - Capitalize all letters in each of the following:; NUMERALS AND UNITS; Express steps in a process in Arabic.
Company Writer's Guide [For Illustration Only] 1-7 Capitalize all letters in each of the following: • Main section headings • Acronyms, initialisms Do not capitalize: • Generic product and component names (for example, controller, panel, switch) • Generic system names • Acronym definitions (unless t...
Page 8 - second; REFERENCES
Company Writer's Guide [For Illustration Only] 1-8 When a spelled-out unit of measurement is used with a quantity, use the singular or plural form of the unit of measurement based on the following criteria: • If the quantity is the unit 1 or a fraction of 1, use the singular form of the spelled-out ...
Page 9 - When listing project-specific documents, follow this example.; Note; Title of journal or larger work in italics, comma.
Company Writer's Guide [For Illustration Only] 1-9 When listing project-specific documents, follow this example. Document number, ABC Project, “XYZ System General Requirements,” Business Unit, date. Note It is not necessary to give the revision level of project documents unless there is a specific r...
Page 10 - Reference callouts may be of two types.; GRAPHICS; Cite all graphics in text, with corresponding numbers.; EDITING CONVENTIONS
Company Writer's Guide [For Illustration Only] 1-10 5. The ordering of documents in the reference list should correspond to the sequence of references used in the document, so that Reference 1 is the first one used, 2 the second, and so on. 6. Reference callouts may be of two types. “This methodolog...
Page 13 - the process next month.
Company Writer's Guide [For Illustration Only] 1-13 post-heat post-test preheat preoperational pre-procurement pre-service (um) proactive pushbutton read-out (n, um) real-time (um) record-keeping (um) remote-handled (um) roundtable self-sufficient (um) set point shear wave (um) shutdown sign-off (n,...
Page 14 - APPENDIX A; Cisco® is a registered trademark of Cisco Systems, Incorporated.
Company Writer's Guide [For Illustration Only] A-1 APPENDIX A COMMONLY USED TRADEMARKS The first use of a trademark name should include “®” or “™” as appropriate. The following are the most often-used trademarks in our business as they should appear under “Acronyms and Trademarks” in the front matte...
Page 16 - APPENDIX B; The following common Latin abbreviations should appear as:
Company Writer's Guide [For Illustration Only] B-1 APPENDIX B ABBREVIATIONS AND SYMBOLS Abbreviations facilitate reading and minimize dull repetition of cumbersome names. Abbreviations should be used only when necessary and when their meanings are unquestionably clear. When in doubt, spell it out. I...
Page 17 - Below are a few commonly used abbreviations in their proper form:; Plurals of Abbreviations; Acronyms, letters, and numbers are made plural by adding “s” alone:
Company Writer's Guide [For Illustration Only] B-2 4. When using unit abbreviations such as Btu, kW, Hz. . . a space should be placed between the number and the abbreviation. e.g.; 100 Btu, 3 kW, 50 Hz. 5. Refrain from using the symbols " and ' for inches and feet unless referring to a plant ele...
Page 18 - Letter Symbols for Units of Measurement
Company Writer's Guide [For Illustration Only] B-3 3. Abbreviations with periods, lower-case letters used as nouns, and capital letters that would form another word if “s” alone were added form the plural with an apostrophe and an “s”: Ph.D.’s x’s and y’s S’s, A’s, I’s Letter Symbols for Units of Me...
Page 19 - Symbols for Units in General Use
Company Writer's Guide [For Illustration Only] B-4 Symbols for Units in General Use Unit Symbol Notes ampere A SI unit of electric current. ampere (turn) A SI unit of magnetomotive force. ampere-hour Ah Also A•h ampere per meter A/m SI unit of magnetic field strength. angstrom Δ 1 Δ = 10 -10 m (depr...
Page 20 - Symbols for Units in General Use (Cont’d)
Company Writer's Guide [For Illustration Only] B-5 Symbols for Units in General Use (Cont’d) Unit Symbol Notes bel B becquerel Bq SI unit of activity of a radionuclide. billion electronvolts GeV The name gigaelectronvolt is preferred for this unit. bit b In information theory, the bit is a unit of i...
