PCS 3000 Ultra Flow Controller Quick Reference Guide

Pen On The Road:

• help system
• user guide

PENTAX PocketJet^TM:

• quick reference guide
• user guide

Plan (Phase 2)

Process:

• Phase 1 - Assess needs
• Phase 2 - Plan
• Phase 3 - Acquire information
• Phase 4 - Organize content
• Phase 5 - Design the look and feel
• Phase 6 - Write
• Phase 7 - Illustrate
• Phase 8 - Review and revise
• Phase 9 - Test
• Phase 10 - Publish

Publish (Phase 10)

Pyramid Peak photo

Q

Quick reference guide:

• Impact specialty
• sample - How to Apply for an Internal Job
• sample - PCS 3000 Ultra Flow Controller
• sample - PENTAX PocketJet^TM

Quick start guide:

Reference manual - Impact specialty

Return on investment

Review and revise (Phase 8)

Rogues' gallery of bad documentation

Sample:

• business case - computer operating system
• business case - office-automation equipment
• help system - Pen On The Road
• help system - Time Reporting System
• quick reference guide - How to Apply for an Internal Job
• quick reference guide - PCS 3000 Ultra Flow Controller
• quick reference guide - PENTAX PocketJet^TM
• quick start guide - WellTender II
• technical overview - Classys Sales Automation
• user guide - Pen On The Road
• user guide - PENTAX PocketJet^TM
• user guide - Time Reporting System
• user guide - WellTender
• white paper - ACIS Open Modeling Primer

Savings provided by good user documentation

Software documentation projects

Specialties

T

Usability testing

User guide:

• Impact specialty
  sample - PENTAX PocketJet^TM
• sample - Time Reporting System
• sample - WellTender
• sample - Using Pen On The Road

Wagner, Richard

Welcome

WellTender:

• Operator Guide
• Quick Start Guide

White paper:

• avoid mistakes
• bibliography
• explain concepts
• Impact specialty
• links to excellent examples
• myths
• sample - ACIS Open Modeling Primer
• show business value
• target your audience
• tips
• writing guide

White Paper Writing Guide

Write (Phase 6)

Writer's block