Software Product Documentation
Posted by Adriana Iordan on: 2006-09-10 17:29:50
Self SEO > Software Articles
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
- Ship date
- Company and Author Name
- Description (like "photo organizer")
- A What’s New 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 that 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 full article.
Copyright © 2006, www.avangate.com all rights reserved.
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.
Print this article
Tell a friend
 | Related Articles |
 | User comments: |
dagwood255
-
Posted on: 2010-08-26 17:03:21
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.
The complete volume of Software AG's product documentation can be found in Empower, Software AG's global extranet.
______________
Unique Gifts
Valentine Gifts
johnathan6418
-
Posted on: 2010-09-25 09:08:01
Involvement of people in software life
Requirements documentation is the description of what a particular software does or shall do. It is used throughout development to communicate what the software does or shall do. It is also used as an agreement or as the foundation for agreement on what the software shall do.
__________________
Ratchet Straps
Lifting Slings
Timothy8797
-
Posted on: 2010-11-09 16:15:59
Besides the quality of the software product, theres 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.
------------------------------------------------
USANA
graham
-
Posted on: 2011-01-05 18:08:48
If all the software developers would keep count of these advises we would all be more satisfied. Yet, it could be worse, once you know how to handle a software you don't need much help from the technical support, do you, not unless the software has a bad script...
Graham -
regcure
jerremy255
-
Posted on: 2011-02-25 04:31:44
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.
________________
SEO Florida
Florida SEO
elithawilliam
-
Posted on: 2011-05-16 12:28:58
I found this a very ideal product and will definitely free from the errors. This can lead to better quality product.
KVM Switch
phoenixp160
-
Posted on: 2011-05-23 10:53:45
Documentation for your Software
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.
_____________
SEO
Search Engine Optimization
phoenixp160
-
Posted on: 2011-05-25 06:42:05
Documentation for your Software
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.
_______________
Seo Orlando
Seo Florida
phoenixp160
-
Posted on: 2011-05-28 09:13:18
Q3 Technologies is one of the best outsourced product development company. Q3 technologies provides you the best solution for outsourced software development. Q3 Technologies also provides the solution for all types of web based software.
_______________
Heathrow Taxi
Gatwick Taxi
phoenixp160
-
Posted on: 2011-06-06 10:28:07
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.
_________________
Roller Blinds
Blinds
jerremy255
-
Posted on: 2011-06-13 08:32:04
Learn How to Write Good Documentation for your Software
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.
________________
Seo Optimization
Website Optimization
jerremy255
-
Posted on: 2011-06-23 09:16:23
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.
________________
Seo Packages
Seo Package
jerremy255
-
Posted on: 2011-06-30 07:16:08
Documentation for your Software
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.
_______________
Seo Marketing
Marketing Seo
webmaster.mcintosh
-
Posted on: 2011-07-01 11:06:42
You have mention needful files which we always seen in our software documentation.
Car Speakers
Car Amplifiers
phoenixp160
-
Posted on: 2011-07-07 11:34:17
Several How-to and overview documentation are found specific to the software application or software product being documented by API Writers.
________________
Seo Reseller
Reseller SEO
watson012
-
Posted on: 2011-08-08 06:40:25
I am really great for the great info that to very amazing technology is visible in this blog
WebHostingPad
phoenixp160
-
Posted on: 2011-08-08 06:43:10
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.
________________
Internet Marketing
Search Engine Marketing
 | Post New Comment |
This site does not allow anonymous comments. Registered members can
login to participate.
Registration is free and takes only a few seconds