Software Product Documentation

<h1>Software Product Documentation</h1>Author: <a title="Adriana Iordan" href="http://www.articlesbase.com/authors/adriana-iordan/6771.htm">Adriana Iordan</a> The ideal software would be free of errors and so easy to use that everybody would be familiar with it the minute they start the application. However, this is not the case in real life.
Besides the quality of the software product, there's something else that makes or breaks the deal: technical support. The better the support software publishers and shareware authors provide, the more users are likely to buy the product.
Technical support for software products can be provided in several ways: <ul><li>online product documentation</li><li>e-mail assistance</li><li>access to support forums maintained by software publishers</li><li>knowledge bases.</li></ul>Good documentation may exclude in many cases the need for further forms of technical support. It is, however, not easy to write. One of the reasons why this happens is that it is difficult for shareware authors or other software developers to put themselves into the users' shoes, since they are already thoroughly familiar with the application.
Read Me file
The first thing every software product should have is a text format "Read Me" file that includes the following:
<ul>
<li>Product Name and Version</li>
<li> Release date</li>
<li> Company and Author Name </li>
<li> Description (like "photo organizer")</li>
<li> A changelog list (this should be a list of fixes and new features)</li>
<li> System requirements (hardware like CPU, RAM, disk space, operating systems supported)</li>
<li> Price, payment options and instructions</li>
<li> Copyright and distribution information (rules for people who want to distribute your product)</li>
<li> Contact details (email, phone, fax website and postal address)</li>
</ul>
The "Read Me" file is important because everybody who might be interested in your product is expecting it, including reviewers, users, or people who want to put your product on a CD for distribution with a magazine or on their website. The idea here is to minimize frustration associated with the information being too difficult to find, therefore you should put all in one place.
The Manual
The other thing shareware authors and software publishers need to provide with their product is the manual. The first thing you should think about when starting to write it is how your users are going to use it. Few are those that will bother reading it all before attempting to use your product. They are more likely to turn to it later, when they try to do something and cannot figure out how to do it, or when they find something they do not understand.
To help them, it is best to organize your documentation by tasks. "How to..." sections are more useful than merely documenting every command in order. Explanations are easier to understand if they are backed by pictures and diagrams, wherever possible. There should also be a chapter labeled "Troubleshooting", which provides answers to the most common problems. At first you will have to guess where those problems may occur, but a couple of upgrades to your product later, the feedback from the people who tried the product will tell you what the most common problems are.
The manual should be broken down into chapters, the first of which telling what the other chapters contain, so that people could readily find what they need.
The interface
Another point worth mentionning is the interface. User friendly is not enough, the interface needs to be navigatable even if the user does not have an overall systems understanding, so screens need to be self-describing.
Online help or online documentation
There is also online help, or online documentation. The documentation put on the website for users to read has to show up in search results. It has to be organized in such a way that users, who are sure to be asking questions like "How can I..." or "Why can't I..." can find the answers quickly. Lots of examples showing how to do various tasks with the software product are also needed. A good idea is to include links to a glossary of terms that might be more difficult to understand.
Always bear in mind that anyone who has had a bad experience with a product tends to remember it for a long time and software is no different. That is why you should strive to make using your product as smooth an experience as possible, something proper support and documentation can help you achieve.
Read more <a href="http://www.avangate.com/articles/">software marketing articles</a> and learn <a href="http://www.avangate.com/ecommerce-services/">how to sell software online</a>.

About the Author: Copyright © 2006, <a href="http://www.avangate.com"> <a href="http://www.avangate.com" target="_blank">www.avangate.com</a></a> all rights reserved. This article was written by a Web Marketing Specialist at Avangate B.V. Avangate is an eCommerce platform for electronic software distribution incorporating an easy to use and secure online payment system plus additional marketing and sales tools. 
This article may be reproduced in a website, e-zine, CD-ROM, book, magazine, etc. so long as the above information is included in full, including the link back to this website.

Article Source: <a href="http://www.articlesbase.com/">ArticlesBase.com</a> - <a href="http://www.articlesbase.com/software-articles/software-product-documentation-48080.html" title="Software Product Documentation">Software Product Documentation</a>

The ideal software would be free of errors and so easy to use that everybody would be familiar with it the minute they start the application. However, this is not the case in real life.

Besides the quality of the software product, there's something else that makes or breaks the deal: technical support. The better the support software publishers and shareware authors provide, the more users are likely to buy the product.

Technical support for software products can be provided in several ways:

online product documentation
e-mail assistance
access to support forums maintained by software publishers
knowledge bases.

Good documentation may exclude in many cases the need for further forms of technical support. It is, however, not easy to write. One of the reasons why this happens is that it is difficult for shareware authors or other software developers to put themselves into the users' shoes, since they are already thoroughly familiar with the application.

Read Me file

The first thing every software product should have is a text format "Read Me" file that includes the following:

Product Name and Version
Release date
Company and Author Name
Description (like "photo organizer")
A changelog list (this should be a list of fixes and new features)
System requirements (hardware like CPU, RAM, disk space, operating systems supported)
Price, payment options and instructions
Copyright and distribution information (rules for people who want to distribute your product)
Contact details (email, phone, fax website and postal address)

The "Read Me" file is important because everybody who might be interested in your product is expecting it, including reviewers, users, or people who want to put your product on a CD for distribution with a magazine or on their website. The idea here is to minimize frustration associated with the information being too difficult to find, therefore you should put all in one place.

The Manual

The other thing shareware authors and software publishers need to provide with their product is the manual. The first thing you should think about when starting to write it is how your users are going to use it. Few are those that will bother reading it all before attempting to use your product. They are more likely to turn to it later, when they try to do something and cannot figure out how to do it, or when they find something they do not understand.

To help them, it is best to organize your documentation by tasks. "How to..." sections are more useful than merely documenting every command in order. Explanations are easier to understand if they are backed by pictures and diagrams, wherever possible. There should also be a chapter labeled "Troubleshooting", which provides answers to the most common problems. At first you will have to guess where those problems may occur, but a couple of upgrades to your product later, the feedback from the people who tried the product will tell you what the most common problems are.

The manual should be broken down into chapters, the first of which telling what the other chapters contain, so that people could readily find what they need.

The interface

Another point worth mentionning is the interface. User friendly is not enough, the interface needs to be navigatable even if the user does not have an overall systems understanding, so screens need to be self-describing.

Online help or online documentation

There is also online help, or online documentation. The documentation put on the website for users to read has to show up in search results. It has to be organized in such a way that users, who are sure to be asking questions like "How can I..." or "Why can't I..." can find the answers quickly. Lots of examples showing how to do various tasks with the software product are also needed. A good idea is to include links to a glossary of terms that might be more difficult to understand.

Always bear in mind that anyone who has had a bad experience with a product tends to remember it for a long time and software is no different. That is why you should strive to make using your product as smooth an experience as possible, something proper support and documentation can help you achieve.

Copyright © 2006, www.avangate.com all rights reserved. This article was written by a Web Marketing Specialist at Avangate B.V. Avangate is an eCommerce platform for electronic software distribution incorporating an easy to use and secure online payment system plus additional marketing and sales tools.

This article may be reproduced in a website, e-zine, CD-ROM, book, magazine, etc. so long as the above information is included in full, including the link back to this website.

Rate this Article:

0 / 5 stars - 0 vote(s)

Re-Publish

Article Source: http://www.articlesbase.com/software-articles/software-product-documentation-48080.html

Article Tags: Manual, Technical Support, Software Product Documentation, Technical Documentation, Read Me File, Software Product Interface, Online Documentation

Related Articles
Related Q&A

Latest Software Articles
More from Adriana Iordan

Three Smart Tips to Keep The x800 GTO Driver Working Accurately

By: Marvin Dunn | 02/12/2009
When you have an x800 GTO video card, the driver might frequently show problem signs. With the right x800 gto driver, your video card will work properly but if you install new components on your system, you might have the misfortune of creating fatal errors and cause the video card to crash.

How to Clean Computer Software in a Nutshell

By: Amit Mehta | 02/12/2009
For PC users looking for a fast, efficient way to keep your hard drive clean and free of errors and to keep your PC running at optimal performance, clean computer software is just the right thing for you. In this article, you can learn about the benefits of registry cleaning software in a nutshell.

The Lowdown on Clean Computer Software

By: Amit Mehta | 02/12/2009
There are many manual options for the everyday PC user to help clean up their PC’s hard drive, but in a technological world where time is money, this job is often left to highly reliable and simplistic clean computer software. The following is a nice overview of exactly how software that cleans computers works for the average user.

Convert SWF to MP4 for Playback on iPod

By: Jessy Brown | 02/12/2009
Flash SWF to iPod video format MP4 conversion is quite popular among younger populations because it supports the flash playback on iPod and other Apple products.This article is about how to convert swf to mp4 for iPod

Five Remarkable Steps to Keep the Radeon x1200 Driver Always Updated

By: Marvin Dunn | 02/12/2009
If you are wondering how you could make sure your radeon x1200 drivers can remain updated forever without requiring you do assist this process again, then here is how you can do it.

Use your Smartphone wisely

By: Charlie | 02/12/2009
We protect our computers with virus scanners and firewalls but there are many customers who do not realise what the dangers are when they don’t use mobile security on their Smartphone. Your mobile phone is open to all sorts of dangers which come from worm viruses and various other viruses which may attack a mobile phone when you are browsing the internet without mobile antivirus software.

Choosing the right Dispatch Software

By: Ray Donovan | 02/12/2009
Owner operators can access the program while traveling so they can keep track of their consumers. Truckers can send e-mails from their rig, or create easy detailed invoices with ease.

Custom Software Application Development Now at Its Matured State

By: Arun Kumar | 02/12/2009
Every business now depends on software applications up to a very great extent. With the use of software apps into the business environment of an organization, product output and work efficiency can be taken to a level where profits speak about the achievements. The use of software applications also minimizes investment cost as it drastically cut down the expenses in manpower recruitment and their wages.

Pricing your Software

By: Adriana Iordan | 11/10/2006 | Marketing
How much do you charge for your software? No one can tell you exact how much you should charge for your software product, but there are some things you need to bear in mind when deciding your software product pricing strategy.

7 Basic Software Marketing Techniques

By: Adriana Iordan | 24/09/2006 | ECommerce
If you are a web developer that sells software online, here are the basic software marketing methods that will help you boost your sales. Learn about each one, and find the winning combination that will bring you more buyers.

Credibility Wins Clients Over

By: Adriana Iordan | 24/09/2006 | ECommerce
You need to ask yourself what you could do to impress your webiste visitors and make them buy software from you, and not from your competitors. So, what can you do? The most important thing in convincing buyers, especially new ones, to shop on your site, is to add credibility to it.