Overview
- Perfect tool for anyone whose job required writing formal documentation
- Contains a thorough introduction to technical writing
- Covers typical grammatical and vocabulary issues
- Includes supplementary material: sn.pub/extras
Part of the book series: Guides to Professional English (GPE)
Access this book
Tax calculation will be finalised at checkout
Other ways to access
Table of contents (32 chapters)
-
Front Matter
-
Structure and Content of a Manual
-
Front Matter
-
-
Writing Clearly, Concisely and Unambiguously
-
Front Matter
-
-
Layout and Order of Information
-
Front Matter
-
Keywords
About this book
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 ideas for writing clear documentation that will reflect well on your company, its image and its brand.
The book has four parts:
Structure and Content: Through examples, you will learn best practices in writing the various sections of a manual and what content to include.
Clear Unambiguous English: You will learn how to write short clear sentences and paragraphs whose meaning will be immediately clear to the reader.
Layout and Order Information: Here you will find guidelines on style issues, e.g., headings, bullets, punctuation and capitalization.
Typical Grammar and Vocabulary Mistakes: This section is divided alphabetically and covers grammatical and vocabulary issues that are typical of user manuals.
Authors and Affiliations
About the author
Bibliographic Information
Book Title: User Guides, Manuals, and Technical Writing
Book Subtitle: A Guide to Professional English
Authors: Adrian Wallwork
Series Title: Guides to Professional English
DOI: https://doi.org/10.1007/978-1-4939-0641-3
Publisher: Springer New York, NY
eBook Packages: Business and Economics, Business and Management (R0)
Copyright Information: Springer Science+Business Media New York 2014
Softcover ISBN: 978-1-4939-0640-6Published: 20 June 2014
eBook ISBN: 978-1-4939-0641-3Published: 19 June 2014
Series ISSN: 2945-5456
Series E-ISSN: 2945-5464
Edition Number: 1
Number of Pages: XVII, 172
Topics: Careers in Business and Mangagement, Popular Science, general