More Details

Table of Contents:

• Machine generated contents note: pt. I Structure and Content of a Manual
• 1. Title
• -table of contents
• -about
• -introduction
• -product overview
• -what's in the box
• 1.1. Title
• 1.2. Table of Contents
• 1.3. About
• 1.4. Introduction / Product overview
• 1.5. What's in the box?
• 1.6. Specifications
• 1.7. Glossaries
• 2. Key Features
• 2.1. Key features
• 3. Installation
• -Getting Started
• 3.1. Installation
• 3.2. Getting started

• 4. Using Your .... Instructions
• Procedures
• 4.1. Giving instructions and writing procedures
• 4.2. Don't make assumptions
• 4.3. Introduce procedures with a colon
• 4.4. Put everything in chronological order
• 4.5. Only have one instruction in each sentence
• 4.6. Tell the reader about the expected results of each step
• 4.7. Put a period at the end of each step
• 4.8. Refer to buttons concisely
• 4.9. Tips
• 5. Troubleshooting
• 5.1. What is a troubleshooting section?
• 5.2. Describing the user's problems
• 5.3. Describing solutions to the user's problems
• 5.4. Tables
• 5.5. Avoid using lists
• 6. Warnings And Recommendations
• 6.1. warning vs recommendation
• 6.2. Where to locate warnings
• 6.3. Use imperatives to express recommendations
• 6.4. Express warnings using the same format and terminology
• 6.5. Repeating the words such as not and never is good practice in warnings
• 6.6. Explain the consequences of ignoring a warning
• 6.7. Use if to explain a consequence
• 7. Updates - warranty - contact details
• 7.1. Updates
• 7.2. Warranty
• 7.3. Contact details
• pt. II Writing Clearly, Concisely and Unambiguously
• 8. Writing From A Reader Perspective
• 8.1. Address the reader directly
• 8.2. Only address the user using you when it is really necessary
• 8.3. Say what your product or service does, not what it is designed to do
• 8.4. Tell the users what they can do and how to do it
• 8.5. Avoid should
• 8.6. Be careful using words like usually, normally and generally
• 8.7. Make it clear to the reader whether he / she has to do something or whether the system does something automatically
• 9. Avoiding Redundancy And Long Sentences
• 9.1. Be concise
• 9.2. Use verbs rather than nouns
• 9.3. Use adjectives rather than nouns
• 9.4. Use verbs rather than adjectives that end in -able
• 9.5. Limit yourself to one idea per sentence
• 9.6. Avoid long sentences
• 9.7. Avoid parenthetical phrases
• 10. Word Order
• 10.1. Key rules for word order
• 10.2. Subject
• 10.3. Verbs
• 10.4. Direct objects and indirect objects
• 10.5. Noun + noun sequences
• 10.6. Adjectives
• 10.7. figure, table, appendix etc
• 10.8. Past participles
• 10.9. Adverbs of frequency + also, only, just, already
• 10.10. Adverbs of probability
• 10.11. Adverbs of manner
• 10.12. Adverbs that indicate a chronological order
• 10.13. Adverbs of time
• 10.14. Adverbs with more than one meaning
• 10.15. Negations
• 11. Terminology
• 11.1. Refer to the same type of reader using the same term
• 11.2. Use the same terminology for the same scenario
• 11.3. Use the most specific word possible
• 11.4. Use the simplest word possible
• 12. Avoiding Ambiguity
• 12.1. Check for ambiguous word order
• 12.2. former, the latter
• 12.3. if and when clauses
• 12.4. Latin words and abbreviations
• 12.5. Be precise
• 12.6. which
• 12.7. may might, can and will
• 13. Automatic Translation
• 13.1. advantages of automatic translation
• 13.2. Typical areas where Google Translate may make mistakes in English
• 13.3. How to improve the chances of getting an accurate automatic translation
• 13.4. Do not use Google Translate to check your English
• pt. III Layout and Order of Information
• 14. Layout
• 14.1. Decide which is clearer: one column or two columns
• 14.2. Avoid long paragraphs
• 14.3. Think about the best order in which to present information
• 14.4. Put information in chronological order
• 14.5. Set out the information in the simplest way
• 14.6. Ensure grammatical consistency
• 15. Headings
• 15.1. Why use headings?
• 15.2. Capitalization
• 15.3. Follow a heading with some text
• 15.4. Do not make headings part of the following text
• 16. Punctuation
• 16.1. Apostrophes (')
• 16.2. Colons (:)
• 16.3. Commas (,)
• 16.4. Hyphens (-)
• 16.5. Parentheses ()
• 16.6. Periods (.)
• 16.7. Semicolons (;)
• 16.8. Forward slash (/)
• 17. Capitalization
• 17.1. Titles of documents
• 17.2. Section headings
• 17.3. Product names
• 17.4. Days, months, countries, nationalities, natural languages
• 17.5. Notes
• 17.6. Acronyms
• 17.7. Ok
• 17.8. Figures, tables, sections
• 17.9. Steps, phases, stages
• 17.10. Keywords
• 18. Abbreviations And Acronyms
• 18.1. Limit usage of abbreviations
• 18.2. Quantities
• 18.3. Introducing an acronym
• 18.4. Punctuation
• 18.5. Duplication
• 19. Bullets
• 19.1. Types of bullets
• 19.2. When to use
• 19.3. Punctuation
• 19.4. Introducing bullets
• 19.5. Avoid redundancy
• 19.6. Bullets after section titles
• 19.7. One idea per bullet
• 19.8. Grammatical consistency
• 20. Figures, Tables And Captions
• 20.1. Making reference to figures
• 20.2. Numbering figures
• 20.3. Abbreviations with figures, tables, appendices etc
• 20.4. Captions to figures
• 20.5. Use tables to show information quickly and clearly
• 21. Dates And Numbers
• 21.1. Day / Month / Year
• 21.2. Decades
• 21.3. Words (twelve) vs digits (12)
• 21.4. Points vs commas
• 21.5. Ranges, fractions, periods of time
• 21.6. Percentages
• 22. Giving Examples
• 22.1. for example
• 22.2. e.g., i.e.
• 22.3. etc
• 22.4. Dots(...)
• 23. Referencing
• 23.1. Sections and documents
• 23.2. Figures, tables, windows
• 23.3. following
• 23.4. above mentioned / as mentioned above
• 23.5. hereafter
• 24. Spelling
• 24.1. US vs GB spelling
• 24.2. Technical words
• 24.3. Misspellings that automatic spell checkers do not find
• pt. IV Typical Mistakes
• 25. Comparisons
• 25.1. Comparative vs superlative
• 25.2. Adverbs and prepositions used with comparisons
• 25.3. more... the more
• 26. Definite Article (The), Indefinite Article (A, AN), One
• 26.1. Definite article: main uses
• 26.2. Definite article: other uses
• 26.3. / an + singular countable nouns
• 26.4. Uncountable nouns
• 26.5. vs an
• 26.6. / an vs one
• 27. Genitive
• 27.1. General usage
• 27.2. Companies
• 27.3. Countries and towns
• 27.4. Periods of time
• 28. Infinitive Vs Gerund
• 28.1. Infinitive
• 28.2. Gerund vs infinitive
• 28.3. Gerund
• 28.4. by vs thus + gerund
• 29. Negations
• 29.1. Position
• 29.2. Contractions
• 29.3. no one vs anyone
• 29.4. Double negatives
• 29.5. also, both
• 30. Passive Vs Active
• 30.1. Addressing the user
• 30.2. Referring to lists, figures, tables and documents
• 30.3. When the passive must be used
• 31. Pronouns
• 31.1. you
• 31.2. we, us, our
• 31.3. he, she, they
• 31.4. users
• 31.5. it, this
• 31.6. one, ones
• 31.7. that, which, who
• 31.8. that vs which
• 32. Vocabulary
• 32.1. allow, enable, permit, let
• 32.2. function, functionality, feature
• 32.3. (the) last, (the) next
• 32.4. login vs log in, startup vs start up, etc
• 32.5. and
• 32.6. as, as it
• 32.7. both ... and, either ... or
• 32.8. even though, even if
• 32.9. in case, if
• 32.10. instead, on the other hand, whereas, on the contrary.

View 208 more lines View less

Author/Creator:

Wallwork, Adrian , author

Contributors:

Ebooks Corporation

Languages:

English

Language Notes:

Item content: English

Main Work:

User guides, manuals, and technical writing: a guide to professional English [by Wallwork, A.]

Related Series:

Guides to professional English

Subjects:

Business writing — Handbooks, manuals, etc.

Technical writing — Handbooks, manuals, etc.

English language — Business English

Business writing

Technical writing

English language

Genres:

Handbooks and manuals

General Notes:

Electronic reproduction. Perth, W.A. Available via World Wide Web.
Description based on online resource; title from PDF title page (Ebsco, viewed June 24, 2014).
Includes index.

Physical Description:

1 online resource.

Digital Characteristics:

text file

Call Numbers:

HF5726 .W35 2014eb

ISBNs:

9781493906413 (electronic bk.)
1493906410 (electronic bk.)
9781493906406 [Invalid]

OCLC Numbers:

881719875

Other Control Numbers:

EBC1782017 (source: MiAaPQ)
[Unknown Type]: ybp11951008