How to Write Software User Manuals

How to Write Software User Manuals

Plain English guide based on IEEE Std 1063

not yet rated
Author: David Tuffley
Length: 94 page(s)
Written: Apr 2011
Sales Rank: 17 XinXii Sales Rank
Views: 5320

Category: Computer & IT » Projekt Management  |  Work: Guidebook
Keywords: software user manual, user documentation, software quality, software development project, project management

Practical guide for developers of software user manuals


Good manuals are a scarce commodity - expensive to produce, difficult to maintain, the province of experts. Not any more. With this new step-by-step guide you can produce successful manuals at a fraction of the normal cost. And the bonus is that they will satisfy the AS 3563 and ISO 9001 standards.

How to Write User Manuals is a complete step-by-step guide designed for people in your organisation with average literacy skills and no prior technical writing experience. By simply following the steps, a person can produce manuals that really work. The result - happy users and big savings on consultants and/or training course fees.

The Guide comes complete with templates for WordPerfect and Word for Windows which allow the writer to produce professional-looking manuals from the start.

S O W H A T M A K E S A N E F F E C T I V E M A N U A L ?

Organisation - Good manuals are well-structured with comprehensive table of contents and index.
Content - The material focuses on user tasks, provides clear instructions and is concise.
Appearance - The presentation is attractive with plenty of white space, and are packaged in booklets that are easy to use.
Language - The text is easy to read and aimed specifically at the users.
What to Avoid - Users dislike manuals that are: inaccurate, contain too much detail, talks down to people, is too formal, is poorly presented and/or organised.
How to Write User Manuals was written by David Tuffley, a specialist documentation consultant since 1990 has worked with large public and private sector clients in Australia and the United Kingdom.

NOTE: The Excerpt available from this web-page is a template that writers of user manuals can use. The book is built around this template, and explains in detail the process. Project staff with passable writing skills can use this guide to write a quality user manual.

Seller assumes all responsibility for this listing.

About the Author

David Tuffley | Author on

Member since: Apr 2011
Publications on XinXii:  25
My social profiles on...
Dr. David Tuffley is a Senior Lecturer in Applied Ethics and SocioTechnical Studies at Griffith University’s School of ICT. A regular contributor to mainstream media on the social impact of technology, David is a recognized expert in his field. Before academia David worked as an IT Consultant in Australia and the United Kingdom, a role he continues to perform when not educating the next generation of IT professionals. David is an engaging science communicator of many years experience, David was a guest panelist in the 2017 World Science Festival and a wide variety of high profile public events.

David's academic background includes fields as diverse as Psychology, Anthropology, Classical Rhetoric and English literature at the University of Queensland. David is an engaging professional speaker and forum moderator of many years experience.

David's formal qualifications include a PhD (Software Engineering), Master of Philosophy (Information Systems), Grad Cert in Higher Education (all from Griffith University), Bachelor of Arts majoring in Psychology, English Literature, Anthropology (University of Queensland)

No review yet.

  $ 2.21
VAT included
Instantly download after purchase
Adobe Reader
File format:
Look Inside