• Throughout the development of a software solution, various forms of documentation are created. 
• We have already discussed the need for continually updating documentation throughout the development process. 
• In this section, we examine the total documentation required before software solutions are released to clients. 
• Documentation can be split into two broad categories: 
• user documentation and 
• technical documentation. 
• These categories describe the intended audience of the documentation. 
• The nature of the software product and its intended audience will determine the language and complexity of each documentation item.

---

User Documentation

Users are the final operators of the product. Documentation targeted at users needs to be directed at their level of knowledge and expertise. 

There are many types of user documentation possible. In this section, we examine four specific types of documentation that are provided with the majority of software products. Each of these documentation types is commonly provided in either printed or electronic formats.

Installation Guide

Installation guides should provide the user with sufficient information to successfully install the software product on their machine(s). Hardware and software requirements will be included together with step-by-step instructions to guide the user through the set-up process. Often notes are included to help resolve common installation problems.

User Manual

Quality user manuals aim to provide concise and accurate information in regard to the operation and purpose of software. Topics in user manuals describe what tasks the software can complete, why these tasks are required and how these tasks are completed using the software. 

Reference Manual

Reference manuals are designed to be an efficient source of information. In terms of software, a reference manual should succinctly describe each command within the application. Reference manuals are not designed to be read from start to finish, rather they will be read in random order as needs arise.

Tutorials

Tutorials provide instruction in the use of software products using example scenarios. The user is lead step-by-step through the processes included in the product. The user performs the tasks under the direction of the tutorial. Tutorials are designed so users can experience real world use of the application before using their own data.

Online Help

Each of the above types of user documentation can be in either printed or electronic online form. It is now common for most user documentation to be provided online rather than as printed manuals. 

• Online documentation can be provided as Adobe PDF files which are often similar in structure to more traditional printed manuals; 
• however dedicated hypertext documents are now more common. Hypertext help documents allow users to efficiently search for specific items or in many cases they allow context sensitive help to be provided from within the application. When the user selects help within the application they are directed to the most relevant help topic automatically.

---

Technical Documentation

• Technical documentation is designed for an audience who are proficient and knowledgeable in regard to the subject matter. In terms of software products, technical documentation primarily describes the structure and engineering behind a product.
• Whilst software is being developed, thorough documentation should be maintained.
• These documents form the basis of the final technical documentation. Personnel involved in maintaining, upgrading and supporting software solutions make use of technical documentation.

Log Books (or process diaries)

• A log book records the systematic series of actions that have occurred during the development of a project.

Source Code Documentation

Implementation Methods

The chosen approach can affect the timing and types and depth of documentation.

---

Documentation and Implementation  Summary Questions

HSC Style Questions