HP TextEngineer Technical Writing Guide Manuel d'utilisateur

Company Writer's Guide [For Illustration Only] 1-1 SECTION 1 STYLE GUIDE

Company Writer's Guide [For Illustration Only] 1-10 5. The ordering of documents in the reference list should correspond to the sequence of r

Company Writer's Guide [For Illustration Only] 1-11 AC air flow Alloy 750 around-the-clock (um) ASME Code B.S., M.S. backfit backflow backlit

Company Writer's Guide [For Illustration Only] 1-12 hard-copy (um) hard-face (um) hard rock (um) hard-wired heatup (um) high-build (um) high-e

Company Writer's Guide [For Illustration Only] 1-13 post-heat post-test preheat preoperational pre-procurement pre-service (um) proactive push

Company Writer's Guide [For Illustration Only] A-1 APPENDIX A COMMONLY USED TRADEMARKS The first use of a trademark name should include “®”

Company Writer's Guide [For Illustration Only] A-2 Netscape and the Netscape N and Ship's Wheel logos are registered trademarks of Netsca

Company Writer's Guide [For Illustration Only] B-1 APPENDIX B ABBREVIATIONS AND SYMBOLS Abbreviations facilitate reading and minimize dull r

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

Company Writer's Guide [For Illustration Only] B-3 3. Abbreviations with periods, lower-case letters used as nouns, and capital letters that

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.

Company Writer's Guide [For Illustration Only] 1-2 Table 1.1-1. Examples of Wordiness Verbose-ese Equivalent by means of by connect togethe

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 un

Company Writer's Guide [For Illustration Only] B-6 Symbols for Units in General Use (Cont’d) Unit Symbol Notes centipoise cP 1 cP = 1 mPa •

Company Writer's Guide [For Illustration Only] B-7 Symbols for Units in General Use (Cont’d) Unit Symbol Notes darcy D 1 D = 1 cP (cm/s)

Company Writer's Guide [For Illustration Only] B-8 Symbols for Units in General Use (Cont’d) Unit Symbol Notes exa E SI prefix for 1016.

Company Writer's Guide [For Illustration Only] B-9 Symbols for Units in General Use (Cont’d) Unit Symbol Notes gigaelectronvolt GeV gigahe

Company Writer's Guide [For Illustration Only] B-10 Symbols for Units in General Use (Cont’d) Unit Symbol Notes called degree kelvin and as

Company Writer's Guide [For Illustration Only] B-11 Symbols for Units in General Use (Cont’d) Unit Symbol Notes liter L 1 L = 10-3 m3. The

Company Writer's Guide [For Illustration Only] B-12 Symbols for Units in General Use (Cont’d) Unit Symbol Notes metric ton t 1 t = 1,000 k

Company Writer's Guide [For Illustration Only] B-13 Symbols for Units in General Use (Cont’d) Unit Symbol Notes milliliter mL See note for

Company Writer's Guide [For Illustration Only] B-14 Symbols for Units in General Use (Cont’d) Unit Symbol Notes newton per square meter N/

Company Writer's Guide [For Illustration Only] 1-3 3. Make sure that your graphics clearly support information in the text. Have you chosen

Company Writer's Guide [For Illustration Only] B-15 Symbols for Units in General Use (Cont’d) Unit Symbol Notes pound-force foot lbf-ft

Company Writer's Guide [For Illustration Only] B-16 Symbols for Units in General Use (Cont’d) Unit Symbol Notes square foot ft2 square in

Company Writer's Guide [For Illustration Only] B-17 Symbols for Units in General Use (Cont’d) Unit Symbol Notes voltampere VA IEC name and

Company Writer's Guide [For Illustration Only] 1-4 3. Be assertive in your writing. Examples include: • Use “will” not “may,” “plan to,” or

Company Writer's Guide [For Illustration Only] 1-5 In text, use the word form of common abbreviations such as percent, degree, number, equal t

Company Writer's Guide [For Illustration Only] 1-6 1.3 PUNCTUATION Standard rules of English (as defined by Strunk and White1) for grammar an

Company Writer's Guide [For Illustration Only] 1-7 Capitalize all letters in each of the following: • Main section headings • Acronyms, init

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

Company Writer's Guide [For Illustration Only] 1-9 When listing project-specific documents, follow this example. Document number, ABC Project,