1. 1 Technical & Business Writing (ENG-715) Muhammad Bilal Bashir UIIT, Rawalpindi

2. Outline 1. Forms of Software Documentation 1. Tutorial Documentation 2. Procedural Documentation 3. Reference Documentation 2. Process of Software Documentation 1. Usability Process 3. Summary 2

3. Forms of Software Documentation Lecture: 4 3

4. Forms of Software Documentation Applying the principles of software documentation we can create different type of user manuals and help files The form of software documentation we choose to create depends upon the type of user, which the software documenter is going to target i.e. how a user uses the software We can classify users into three major categories  Initial users (Tutorial Documentation)  Intermediate users (Procedural Documentation)  Advanced uses (Reference Documentation) 4

5. Tutorial Documentation This documentation is intended to teach the basic functions and features of the programs in such a way that the initial user can begin applying the program to workspace tasks  e.g. getting started guides, online and printed tutorials This documentation show the relationship of teacher and learner The tutorial document presents all sorts of instructional design tools to assist in learning such as sample scenarios,  e.g. walk-through, demonstrations, rewards for learning 5

6. Tutorial Documentation (Continue…) Tutorial documentation focuses heavily on actions that user can take to evoke problem solving and other productive workplace behaviors 6

7. Procedural Documentation Procedural documentation intends to guide the intermediate user in the everyday use of the program, often when user needs information at the time of use  e.g. user guides and help files consisting of step-by-step procedures  tips and help embedded in the user interface  context sensitive help available at the click of mouse etc. It represents the relationship of guide and mentor This document focuses on operations organized around workspace actions 7

8. Reference Documentation Intended to supply information about the program for advanced users Reference users rarely consults the users guide or tutorials  e.g. alphabetical listing of program features, list of examples, file formats, technical troubleshooting data, data for using an application program, and special program setting Represents the relationship of resource and clients It focuses on interface elements more than tutorial and procedural documentation 8

9. Process of Software Documentation The writer who faces the challenge of creating truly useful task oriented documentation needs to look the process of writing itself and find ways to learn about users Task oriented documentation consist of manuals and help that reflect actual users in all their variety and human forms The process of writing software documentation is called usability process which means the user and their needs drive the writing 9

10. Usability Process Planning Stages  Users interviews to find out what actions user take while using the software  Focus groups to find out user needs and organizational constraints Development Stages  User reviews to see how well the manual fits with workplace tasks  User lab test to gauge the accuracy of manual and help information  User field tests to gather additional information about workplace uses 10

11. Usability Process (Continue…) Evaluation Stages  User field evaluation to assess the overall value of documents  User usage report to help adjust writing and research processes for subsequent releases 11

12. 12 Summary Any Questions?