Index

A

abbreviations

acronyms

affect and effect

among and between

ampersand

and/or

apostrophe

appendixes

artwork, cover

audience

identifying and profiling

multiple levels

B

base font

because and since

benefits of good manuals

binders

binding methods

binding offset

bold

brackets

bullet lists

C

camera-ready manual

can and may

capitalization

capture, screen images

cataloguing in publication data

change bar, use of

chapter modules

checklists, use of

clichés

colloquialisms

colon

comma

comprise

computer files

access

file backup

folder structure

naming conventions

offsite storage

consistency

consultants

contents of manual, organization

contents of manual, standard

appendix

cataloguing in publication data

glossary

home page

index

introduction

list of figures

table of contents

title page

contractions

contractors

conversion software

copyright notice

copyright, borrowing information

costs, estimating

cover design

cross-references

D

dash

dates

decision trees

definitions

desire

detail, level of

development process

benefits of process

overview

flow diagram

diagrams

different

distribution of manual

distribution list

orientation session

who gets a manual

divider tabs

document plan, approval of

documentation hierarchy

drafting the manual

dvorak keyboard

E

editing

copy edit

draft sections

final check

initial edit

tips and methods

effect and affect

ellipses

em dash

en dash

ensure and insure

estimating

number of pages

online manuals

printing and production costs

rules of thumb

sample estimate

time required

exclamation mark

F

feedback

field guides

figures, list of

file organization and protection, computer

filing system

flow diagrams

focus groups

footers

form illustrations

forms, online

fractions

G

gender inclusiveness

gender neutral language

glossary

goals for the manual

graphic lines

graphics

online

preparation

use of

guidebooks

H

headers

headings

attributes

choosing topics

levels

online manuals

tips on using

hierarchy of documentation

HTML, how much to know

hyphen

I

I

icons

if... then... tables

illustrations

form

online

screen

technical

indents

index

generating

keywords

online

rules for creating

information needs

insure and ensure

interview techniques

italics

its and it's

J

jargon

justification

K

keyboards, dvorak vs. qwerty

L

language

language, gender neutral

levels of headings

line spacing

linking

logos, use of

M

maintaining print and online versions

maintenance, of manual, see revisions

managing the process

manual specification

manuals

choosing online or print

development

maintenance, see revisions

online, see online manuals

role in organization

role of

testing

types of

updates, see revisions

margins for printing

master document

me

measurements

milestones

modules

money

myself

N

need

O

objectives, determining

online forms

online manuals

graphics

graphics and logos

headings

inappropriate information

index

linking

mapping methods

modules

navigation information

notification of changes

printing

prototype

publishing

revisions

sample map

structure of information

table of contents

testing

time estimates

topics

using colour

writing for

organization of information

alphabetical

chronological

combination of methods

department

function

menu hierarchy

other methods

random

system

task

topical

outline

preparing

sample

P

page breaks

page control information

page design

common mistakes

graphic lines

headers and footers

justification

line spacing

logos

page breaks

page control information

pre-printed page shells

templates

typeface and size

use of colour

word spacing

page layout

column width

page size

single vs. double-sided print

pages, estimating how many

paragraphs

parallelism

parentheses

passive voice

PDF, viewing files

percent

period

person

photographs

pixel resolution

plain English

planning the manual

playscript

plurals

point of view

possessives

prepositions

presentation methods

bullet lists

checklists

choosing the appropriate method

decision trees

flow diagrams

form illustrations

if... then... tables

notes, cautions, warnings

online forms

playscript procedures

screen illustrations

sidebar text

step-by-step procedures

tables

technical illustrations

text boxes

presently

printing

approval to

double-sided

from browser

margins and binding offset

methods

single-sided

specifications

the manual

printing methods

binder covers

digital printing

distributed printing

divider tabs

offset printing

photocopying

preparing camera-ready master

proof copy

procedures, writing

playscript

step-by-step

progress report, sample

project

end of, hand over

management

scheduling

team

work plan

pronouns

proof copy, from printer

protecting your files

prototype

publishing, online

punctuation

purpose of manual

Q

questionnaires, use of

question mark

quotation marks

quotes, printing

R

readers

feedback

how readers use manuals

learning about

research

resolution

reviews

revisability

revisions

change bar

change issue date

frequency of

manual coordinator

online changes

responsibility for

training for maintenance

update packages

written revision procedure

rule of tens

revision procedures, written

S

sample manual section, preparing

scheduling the project

sample schedule

screen design

graphics

layout

logos

navigation information

pixel resolution

tips on designing

using colour

screen illustrations

screen layout

customizing the browser

width of screen

screen size

section organization

chronological

random

top down

topical

semicolon

sentences

length

structure

syntax

sidebar text

signs, warning, notes, cautions

since and because

slash

small caps

software

for both online and print

for conversions

for web authoring

for writing

types

spacing

special terms, defining

specifications

for binders

for printer

for printing

specifications, manual

spelling and usage

style sheet

styleguides

styles

subject experts, review of content by

syntax

T

table of contents

online

tables

tabs

tasks, analyzing

team, assembling

technical illustrations

technical terms

templates

text boxes

text hierarchy

than and then

that and which

their and there

then and than

there and their

time

time estimates

time sensitive data

tone

training for revising

type size

typeface

typographic conventions

U

underlining

updating the manual

V

verbs

agreement

choice and form

strong verbs

tense

voice

vocabulary choice

W

want

web authoring software

which and that

white space

who and whom

wish

word choice

word processor

automated index

automatic functions

cross-references

format tips

keyboards

master document, creating

page layout and format

styles

table of contents

templates

touch typing

using effectively

word spacing

work plan

work tasks, breakdown

writing

for online reading

generically

level of

level of detail

manual sections

walk-throughs

writing style

acronyms and abbreviations

capitalization

clichés

consistency

contractions

gender neutral

jargon

parallelism

punctuation

sentence length and structure

use of pronouns

verb choice and form

word choice

Y

your and you're