User guides, manuals, and technical writing : a guide to professional English /
This book is intended for anyone whose job involves writing formal documentation. It is aimed at non-native speakers of English, but should also be of use for native speakers who have no training in technical writing.--
Saved in:
| Main Author: | |
|---|---|
| Format: | Electronic eBook |
| Language: | English |
| Published: |
New York :
Springer,
[2014]
|
| Series: | Guides to professional English.
|
| Subjects: | |
| Online Access: | CONNECT |
Table of Contents:
- Part I. Structure and content of a manual
- Title, table of contents, about, introduction, product overview, what's in the box
- Key features
- Installation: getting started
- Instructions: procedures
- Troubleshooting
- Warnings and recommendations
- Updates, warranty, contact details
- Part II. Writing clearly, concisely and unambiguously
- Writing from a reader perspective
- Avoiding redundancy and long sentences
- Word order
- Terminology
- Avoiding ambiguity
- Automatic translation
- Part III. Layout and order of information
- Layout
- Headings
- Punctuation
- Capitalization
- Abbreviations and acronyms
- Bullets
- Figures, tables and captions
- Dates and numbers
- Giving examples
- Referencing
- Spelling
- Part IV. Typical mistakes
- Comparisons
- Definite article (the), indefinite article (a, an), one
- Genitive
- Infinitive vs. gerund
- Negotiations
- Passive vs. Active
- Pronouns
- Vocabulary.
