60 likes | 64 Vues
Building Software Solutions Documentation for Users. Notes are from: Wilson, 2001. Software Design and Development The Preliminary Course. Cambridge Press. pp154-156 and Fowler, 2000. Software Design and Development Preliminary Course. Heinemann Press. pp.208-212.
E N D
Building Software SolutionsDocumentation for Users Notes are from: Wilson, 2001. Software Design and Development The Preliminary Course. Cambridge Press. pp154-156 andFowler, 2000. Software Design and Development Preliminary Course. Heinemann Press. pp.208-212
What is User Documentation for? Used to explain how • to install your program • your program works • to use your program • to connect your program to any hardware • any special operating system requirements • Inputs and outputs of your system • To use common features or to overcome common problems or errors
User Documentation Characteristics • Uses simple and concise language • Non-technical and non-threatening • Aimed at the target audience • Appealing layout/presentation • Easy to follow – step by step • Easy to find information you are looking for
User Documentation Formats • User documentation can be presented in either of the following formats: • Hardcopy • Books • Diagrams/Posters • Reference cards • Online • Online Help • Readme.txt files
Types of Documentation Should include the following • Functional description • Introductory manual • System reference manual • System installation guide • System administrators manual • Trouble shooting guides • Reference cards
Online Help Advantages Include • Available to the user without leaving computer • Can provide help in context to the problem • Cheaper to distribute, maintain and share across multiple locations Can be in form of • Help topics browser • Screen or User instructions (simple instructions at bottom of screen) • Self-teaching tutorials • Wizards • Reference help • Balloon help • PDF versions of paper-based manuals