How to write user help

How to write user help

A product’s user guide or help is an essential element of most items of software or consumer products today.

Well-written help can save hours of confusion and frustration as new users get to grips with tools. It should be concisely written but cover all aspects of the use of the software or product.

The wavemon program for Linux is a monitor for wireless devices. It allows users to watch the signal and noise levels, packet statistics, device configuration and network parameters of their wireless network hardware.

Here’s wavemon’s help file.

screenshot of wavemon help file

Concise isn’t it?

Author: Steve Woods

Generic carbon-based humanoid life form.