SW Documentation

Classes of software documentation

Online help

Error messages

Packaging text and graphics

Tutorials

Installation and setup instructions

Importance of documentation testing

Improves usability

Improves reliability

Lowers support cost

Documentation testing checklist

Audience

Terminology

Content and subject matter

Organising field notes

Note-taking tools

notebook

writing utensils

Techniques for capturing information

Documenting the process

Recording material

Why documentation is necessary

When and how it should be conducted

For whom and by whom information is recorded

Available techniques

Types of end-user documentation

How technical writing differs from other writing

How technical documents are organized

How to plan effective user documentation

The technical writing process

Exploring and documenting experiences and knowledge

Preparing for the interview

Interviewing styles

Interviewing techniques

Mapping interviews