Sample

Here’s a sample showing how Documentation Doctor can improve your manuals.

People Tracker is a powerful (fictional) system for monitoring patterns of room use, for example, how guests move around a hotel lobby.

Before [PDF] [HTML]

Before document editing

The original manual makes the system seem harder to use than it really is:

  • Wordy: Some parts only make sense on second reading - unhelpful for users with English as a second language.
  • Description buried in procedures: Interrupts the task-in-hand.
  • Irrelevant technical content: Off-putting for the non-technical user, an annoying overhead for everybody else.
  • Unclear instructions: Who does what? When?
  • Amateur formatting: Creates a bad first impression and makes it hard to find instructions.

This is the last thing users want when they’re under pressure to get things done.

After [PDF] [HTML]

After Document Editing

After a full edit from Documentation Doctor’s technical authoring service, the new manual is at least as user-friendly as the interface:

  • Simpler wording: Easier to read in a hurry - more helpful for users with English as a second language.
  • Focused content: All information is relevant.
  • Clear instructions: Procedures now leave no room for confusion.
  • Professionally formatted: Creates a better first impression. Instructions now stand out and are easier to follow.

Users no longer need invest mental effort in order to operate the system effectively.