Software User Documentation: A How to Guide for Project Staff

Overview

I N T R O D U C T I O N

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.

Software user Documentation: A How To Guide for Project Staff is a detailed reference guide to the preparation of effective user documentation for computer software ...

See more details below
Other sellers (Paperback)
  • All (3) from $7.15   
  • New (3) from $7.15   
Sending request ...

Overview

I N T R O D U C T I O N

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.

Software user Documentation: A How To Guide for Project Staff is a detailed reference guide to the preparation of effective user documentation for computer software applica-tions.

It is intended for people who wish to develop software user documentation. The format and arrangement of this manual re-flects the principles outlined within it - it 'practices what it preaches'.

No prior knowledge or experience of user documentation writ-ing is assumed. The manual is designed to equip a person with at least average written expression skills with a blueprint of how to prepare a software user manual. Provided the person is prepared to follow the instructions through to completion, the result will be an effective piece of documentation.

It can be used by practicing user documenters and technical writers as a checklist of what to include in a piece of documen-tation.

The information given in this manual conforms with the interna-tionally recognised IEEE Standard 1063 which relates to the requirements for software user documentation.

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.

Read More Show Less

Product Details

  • ISBN-13: 9781461133377
  • Publisher: CreateSpace Publishing
  • Publication date: 4/25/2011
  • Pages: 154
  • Product dimensions: 5.50 (w) x 8.50 (h) x 0.33 (d)

Meet the Author

David Tuffley PhD is lecturer and researcher at Griffith University in Australia. David is a Software Engineer, though his interests range across Comparative Religion, Philosophy, Psychology, Anthropology, Literature, History, Design and Architecture.

David has been an academic since 1999. For 15 years before academia David was a technical writer and later a consultant for public and private sector IT clients in Australia and the United Kingdom. He combines theory and practice in a focussed and disciplined way that has proved effective for solving problems for clients.

Read More Show Less

Customer Reviews

Be the first to write a review
( 0 )
Rating Distribution

5 Star

(0)

4 Star

(0)

3 Star

(0)

2 Star

(0)

1 Star

(0)

Your Rating:

Your Name: Create a Pen Name or

Barnes & Noble.com Review Rules

Our reader reviews allow you to share your comments on titles you liked, or didn't, with others. By submitting an online review, you are representing to Barnes & Noble.com that all information contained in your review is original and accurate in all respects, and that the submission of such content by you and the posting of such content by Barnes & Noble.com does not and will not violate the rights of any third party. Please follow the rules below to help ensure that your review can be posted.

Reviews by Our Customers Under the Age of 13

We highly value and respect everyone's opinion concerning the titles we offer. However, we cannot allow persons under the age of 13 to have accounts at BN.com or to post customer reviews. Please see our Terms of Use for more details.

What to exclude from your review:

Please do not write about reviews, commentary, or information posted on the product page. If you see any errors in the information on the product page, please send us an email.

Reviews should not contain any of the following:

  • - HTML tags, profanity, obscenities, vulgarities, or comments that defame anyone
  • - Time-sensitive information such as tour dates, signings, lectures, etc.
  • - Single-word reviews. Other people will read your review to discover why you liked or didn't like the title. Be descriptive.
  • - Comments focusing on the author or that may ruin the ending for others
  • - Phone numbers, addresses, URLs
  • - Pricing and availability information or alternative ordering information
  • - Advertisements or commercial solicitation

Reminder:

  • - By submitting a review, you grant to Barnes & Noble.com and its sublicensees the royalty-free, perpetual, irrevocable right and license to use the review in accordance with the Barnes & Noble.com Terms of Use.
  • - Barnes & Noble.com reserves the right not to post any review -- particularly those that do not follow the terms and conditions of these Rules. Barnes & Noble.com also reserves the right to remove any review at any time without notice.
  • - See Terms of Use for other conditions and disclaimers.
Search for Products You'd Like to Recommend

Recommend other products that relate to your review. Just search for them below and share!

Create a Pen Name

Your Pen Name is your unique identity on BN.com. It will appear on the reviews you write and other website activities. Your Pen Name cannot be edited, changed or deleted once submitted.

 
Your Pen Name can be any combination of alphanumeric characters (plus - and _), and must be at least two characters long.

Continue Anonymously

    If you find inappropriate content, please report it to Barnes & Noble
    Why is this product inappropriate?
    Comments (optional)