Writing Software Documentation ITSW 1410 Presentation Media Software Instructor: Glenda H. Easter

What Is Software Documentation? Software documentation is a form of writing for both print and online media that supports the efficient and effective use of software in its intended environment.

Software Documentation Refers to the documentation of what’s on a screen, as if the manual and help were a “documentary” of interaction events. Contributes significantly to the value of the software product. Aims to make software useful.

Software Documentation (Continued) Should not only teach features but support workplace tasks with step-by-step accuracy. No longer is aimed directly at experts using a product, but also to guide and teach beginning and intermediate users.

Task Orientation Presents information in chronological order based on the user’s workplace sequences. Also referred to as how-to, step-by-step, procedures, walk-through, and tutorials.

Task Orientation (Continued) Shown in the following forms: tutorials “getting started” chapters or booklets instruction steps job performance aids online help procedures manual procedures