HP TextEngineer Technical Writing Guide Manual do Utilizador Página 1

Consulte online ou descarregue Manual do Utilizador para não HP TextEngineer Technical Writing Guide. HP TextEngineer Technical Writing Guide User's Manual Manual do Utilizador

  • Descarregar
  • Adicionar aos meus manuais
  • Imprimir
  • Página
    / 32
  • Índice
  • MARCADORES
  • Avaliado. / 5. Com base em avaliações de clientes
Vista de página 0
Company Writer's Guide
[For Illustration Only] 1-1
SECTION 1
STYLE GUIDE
This section of the Writer’s Guide is intended to establish a basic writing style that is clear, concise,
and consistent in presentation of information. Technical information requires more stringent
standardization than is common in general usage. Therefore, generating a deliverable to
accommodate an expeditious technical review requires avoiding confusing or ambiguous
statements and unnecessarily verbose descriptions.
1.1 WRITING STYLE APPROACH
Avoid use of colloquialisms in writing. Terms like “putting your best foot forward” or “cutting to
the quick” can be misunderstood by international customers and lead to confusion. Conversational
English is inappropriate for formal business and technical writing. Keep language clear and
precise.
The following guidelines will help improve your writing and allow us to present a standardized
“look and feel” in deliverables to customers.
Great Content, Economically Delivered
The most effective technical writing is taut, information-rich material that easily conveys the most
important points. Here are some ways you can achieve this.
1. Try to restrict acronym use to the five to ten most important acronyms in a subject area and
write out the secondary or peripheral terms.
2. Always write in a simple and direct style by avoiding:
Wordiness (examples of wordiness appear in Table 1.1-1)
Strings of adjectives
Puffery (Our company is uniquely qualified ...)
Phrases and words that obscure the central meaning, for example:
Wrong: The system is designed such that active components are capable of being tested
during plant operation.
Right: The active components can be tested during plant operation.
Vista de página 0
1 2 3 4 5 6 ... 31 32

Resumo do Conteúdo

Página 1 - 1.1 WRITING STYLE APPROACH

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

Página 2

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

Página 3

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

Página 4

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

Página 5

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

Página 6 - 1.4 CAPITALIZATION

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

Página 7 - 1.5 NUMERALS AND UNITS

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

Página 8 - 1.6 REFERENCES

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

Página 9

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

Página 10 - 1.8 EDITING CONVENTIONS

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

Página 11 - Company Writer's Guide

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.

Página 12

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

Página 13

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

Página 14 - COMMONLY USED TRADEMARKS

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 •

Página 15

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)

Página 16 - APPENDIX B

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.

Página 17

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

Página 18

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

Página 19

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

Página 20

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

Página 21

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

Página 22

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/

Página 23

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

Página 24

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

Página 25

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

Página 26

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

Página 27

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

Página 28

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

Página 29

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

Página 30

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

Página 31

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

Página 32

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

Comentários a estes Manuais

Sem comentários