Skip to main content
  • Book
  • © 2014

User Guides, Manuals, and Technical Writing

A Guide to Professional English

Authors:

  • 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)

Buy it now

Buying options

eBook USD 19.99
Price excludes VAT (USA)
  • Available as EPUB and PDF
  • Read on any device
  • Instant download
  • Own it forever
Softcover Book USD 29.99
Price excludes VAT (USA)
  • Compact, lightweight edition
  • Dispatched in 3 to 5 business days
  • Free shipping worldwide - see info

Tax calculation will be finalised at checkout

Other ways to access

This is a preview of subscription content, log in via an institution to check for access.

Table of contents (32 chapters)

  1. Front Matter

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

    1. Front Matter

      Pages 1-1
    2. KEY FEATURES

      • Adrian Wallwork
      Pages 9-10
    3. INSTALLATION—GETTING STARTED

      • Adrian Wallwork
      Pages 11-13
    4. TROUBLESHOOTING

      • Adrian Wallwork
      Pages 21-24
    5. WARNINGS AND RECOMMENDATIONS

      • Adrian Wallwork
      Pages 25-30
    6. UPDATES - WARRANTY - CONTACT DETAILS

      • Adrian Wallwork
      Pages 31-32
  3. Writing Clearly, Concisely and Unambiguously

    1. Front Matter

      Pages 33-33
    2. WRITING FROM A READER PERSPECTIVE

      • Adrian Wallwork
      Pages 35-39
    3. AVOIDING REDUNDANCY AND LONG SENTENCES

      • Adrian Wallwork
      Pages 41-45
    4. WORD ORDER

      • Adrian Wallwork
      Pages 47-61
    5. TERMINOLOGY

      • Adrian Wallwork
      Pages 63-66
    6. AVOIDING AMBIGUITY

      • Adrian Wallwork
      Pages 67-71
    7. AUTOMATIC TRANSLATION

      • Adrian Wallwork
      Pages 73-79
  4. Layout and Order of Information

    1. Front Matter

      Pages 81-81
    2. LAYOUT

      • Adrian Wallwork
      Pages 83-88
    3. HEADINGS

      • Adrian Wallwork
      Pages 89-90
    4. PUNCTUATION

      • Adrian Wallwork
      Pages 91-97

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

  • Pisa, Italy

    Adrian Wallwork

About the author

Wallwork, a native English speaker from the UK, has 25 years of experience teaching English at various IT companies in Pisa, Italy. He has published 13 books with Springer Science+Business Media.

Bibliographic Information

Buy it now

Buying options

eBook USD 19.99
Price excludes VAT (USA)
  • Available as EPUB and PDF
  • Read on any device
  • Instant download
  • Own it forever
Softcover Book USD 29.99
Price excludes VAT (USA)
  • Compact, lightweight edition
  • Dispatched in 3 to 5 business days
  • Free shipping worldwide - see info

Tax calculation will be finalised at checkout

Other ways to access