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. Technical writing is a skill that you can learn and this book outlines some simple...
Saved in:
| Main Author: | |
|---|---|
| Corporate Author: | |
| Format: | Electronic eBook |
| Language: | English |
| Published: |
New York, NY :
Springer New York : Imprint: Springer,
2014.
|
| Edition: | 1st ed. 2014. |
| Series: | Guides to Professional English
|
| Subjects: | |
| Online Access: | https://doi.org/10.1007/978-1-4939-0641-3 |
| Tags: |
Add Tag
No Tags, Be the first to tag this record!
|
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.