1 / 6

Building Software Solutions Documentation for Users

Learn how to create user documentation for software, covering installation, usage, hardware connections, OS requirements, and troubleshooting guides. Discover different formats like hardcopy, online help, and readme files. Enhance user experience with non-technical language, step-by-step instructions, and appealing layouts.

kellybarrett
Download Presentation

Building Software Solutions Documentation for Users

An Image/Link below is provided (as is) to download presentation Download Policy: Content on the Website is provided to you AS IS for your information and personal use and may not be sold / licensed / shared on other websites without getting consent from its author. Content is provided to you AS IS for your information and personal use only. Download presentation by click this link. While downloading, if for some reason you are not able to download a presentation, the publisher may have deleted the file from their server. During download, if you can't get a presentation, the file might be deleted by the publisher.

E N D

Presentation Transcript

  1. 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

  2. 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

  3. 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

  4. 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

  5. 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

  6. 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

More Related