Technical and Business Writing

Lecture Slides
By
Rana Muhammad Yaseer

Department of Information Technology and Science

The Forms of Software Documentation
Forms of Software Documentation

• Applying the principles of software documentation we

can create different type of
• user manuals
• 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
Classify Users

• We can classify users into three major categories

1. Initial users (Tutorial Documentation)

2. Intermediate users (Procedural Documentation)
3. Advanced uses (Reference Documentation)
Tutorial Documentation
for
Initial users
1- 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
Tutorial Documentation (Continue…)

• 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

• Tutorial documentation focuses heavily on actions that

user can take to evoke problem solving and other
productive workplace behaviors
Tutorial Documentation Example
Procedural Documentation
for
Intermediate users
2- 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
Procedural Documentation Example
• Workspaces are the directories, databases and file
folders on disk that hold numerous datasets.
• workspaces may consist of a single file folder containing
many datasets
Reference Documentation
for
Advanced uses
Reference Documentation
• Intended to supply information about the program
for advanced users
• Reference users rarely consults the users guide or
tutorials(cannot use website as reference)
• 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
Reference Documentation Examples
 Thanks
Best of luck