User Guides, Manuals, and Technical Writing

A Guide to Professional English

  • Adrian Wallwork

Part of the Guides to Professional English book series (GPE)

Table of contents

  1. Front Matter
    Pages i-xvii
  2. Structure and Content of a Manual

    1. Front Matter
      Pages 1-1
    2. Adrian Wallwork
      Pages 9-10
    3. Adrian Wallwork
      Pages 11-13
    4. Adrian Wallwork
      Pages 15-20
    5. Adrian Wallwork
      Pages 21-24
    6. Adrian Wallwork
      Pages 25-30
    7. Adrian Wallwork
      Pages 31-32
  3. Writing Clearly, Concisely and Unambiguously

    1. Front Matter
      Pages 33-33
    2. Adrian Wallwork
      Pages 35-39
    3. Adrian Wallwork
      Pages 41-45
    4. Adrian Wallwork
      Pages 47-61
    5. Adrian Wallwork
      Pages 63-66
    6. Adrian Wallwork
      Pages 67-71
    7. Adrian Wallwork
      Pages 73-79
  4. Layout and Order of Information

    1. Front Matter
      Pages 81-81
    2. Adrian Wallwork
      Pages 83-88
    3. Adrian Wallwork
      Pages 89-90
    4. Adrian Wallwork
      Pages 91-97

About this book

Introduction

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.

Adrian Wallwork is the author of over 30 books aimed at helping non-native English speakers to communicate more effectively in English. He has published 13 books with Springer Science+Business Media. 

Other books in this Professional English series:

Email and Commercial Correspondence

CVs, Resumes, and LinkedIn

Meetings, Negotiations, and Socializing

Presentations, Demos, and Training Sessions

Telephone and Helpdesk Skills

Keywords

grammar language structure layout

Authors and affiliations

  • Adrian Wallwork
    • 1
  1. 1.PisaItaly

Bibliographic information

  • DOI https://doi.org/10.1007/978-1-4939-0641-3
  • Copyright Information Springer Science+Business Media New York 2014
  • Publisher Name Springer, New York, NY
  • eBook Packages Business and Economics
  • Print ISBN 978-1-4939-0640-6
  • Online ISBN 978-1-4939-0641-3
  • About this book
Industry Sectors
Pharma
Automotive
Chemical Manufacturing
Biotechnology
Electronics
Consumer Packaged Goods
Engineering