HP TextEngineer Technical Writing Guide - Manual

HP TextEngineer Technical Writing Guide

HP TextEngineer Technical Writing Guide – Manual, read for free online in PDF format. We hope this helps you resolve any issues you may have. If you have further questions, please contact us through the contact form.

1 Page 1
2 Page 2
3 Page 3
4 Page 4
5 Page 5
6 Page 6
7 Page 7
8 Page 8
9 Page 9
10 Page 10
11 Page 11
12 Page 12
13 Page 13
14 Page 14
15 Page 15
16 Page 16
17 Page 17
18 Page 18
19 Page 19
20 Page 20
21 Page 21
22 Page 22
23 Page 23
24 Page 24
25 Page 25
26 Page 26
27 Page 27
28 Page 28
29 Page 29
30 Page 30
31 Page 31
32 Page 32
Page: / 32

Table of Contents:

  • Page 2 – Company Writer's Guide; Verbose-ese Equivalent
  • Page 3 – Verb Tenses; Use active voice to raise impact. Examples include:; Additional Guidance
  • Page 4 – Be assertive in your writing. Examples include:
  • Page 6 – PUNCTUATION
  • Page 7 – Capitalize all letters in each of the following:; NUMERALS AND UNITS; Express steps in a process in Arabic.
  • Page 8 – second; REFERENCES
  • Page 9 – When listing project-specific documents, follow this example.; Note; Title of journal or larger work in italics, comma.
  • Page 10 – Reference callouts may be of two types.; GRAPHICS; Cite all graphics in text, with corresponding numbers.; EDITING CONVENTIONS
  • Page 13 – the process next month.
  • Page 14 – APPENDIX A; Cisco® is a registered trademark of Cisco Systems, Incorporated.
  • Page 16 – APPENDIX B; The following common Latin abbreviations should appear as:
  • 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:
  • Page 18 – Letter Symbols for Units of Measurement
  • Page 19 – Symbols for Units in General Use
  • Page 20 – Symbols for Units in General Use (Cont’d)
Loading the manual

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.

"Loading the manual" means you need to wait until the file loads and becomes available for online reading. Some manuals are very large, and the time they take to appear depends on your internet speed.

Summary

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...

Other HP Models

All HP Other