ISO/IEC TR 9294:2005

Foreword
Introduction
1 Scope
2 Normative references
3 Terms and definitions
4 The managerial role
   4.1 Overview
   4.2 Evidence of managerial commitment and support
5 The functions of software documentation
   5.1 Overview
   5.2 Communication to management
   5.3 Task-to-task communication
   5.4 Quality assurance
   5.5 Instruction and reference
   5.6 Software support
   5.7 Historical reference
6 Establishing documentation policies
7 Establishing documentation standards and guidelines
   7.1 Overview
   7.2 Selecting a software life cycle model
   7.3 Defining document type and content
        7.3.1 Introduction
        7.3.2 Development documentation
        7.3.3 Product documentation
        7.3.4 Project management documentation
   7.4 Defining document quality
   7.5 Defining document formats
   7.6 Defining a document identification system
8 Establishing documentation procedures
9 Allocating resources to documentation
   9.1 People
        9.1.1 Managers
        9.1.2 Project Team Members
   9.2 Facilities
   9.3 Funding
10 Documentation plan
   10.1 Overview
   10.2 Information in the documentation plan
   10.3 Documentation schedule
Annex A (informative) Checklist for software documentation management
   A.1 Policies checklist
   A.2 Standards checklist
   A.3 Procedure checklist
   A.4 Project planning checklist
Bibliography

ISO/IEC TR 9294:2005 offers guidance on the management of software documentation to managers responsible for the production of software or software-based products. This guidance is intended to assist managers in ensuring that effective documentation is produced in their organizations.

ISO/IEC TR 9294:2005 addresses the policies, standards, procedures, resources and plans with which managers must concern themselves in order to manage software documentation effectively.

The guidance given is intended to be applicable to all types of software, from the simplest program to the most complex software suite or software system. All types of software documentation are covered, relating to all stages of the software life cycle.

The principles of software documentation management are the same whatever the size of a project. For small projects, much of the detail given in ISO/IEC TR 9294:2005 may not apply, but the principles remain the same. Managers may tailor the recommendations to their particular needs.

The guidance given is from the point of view of software documentation management. Detailed advice is not provided on, for example, the content and layout of software documents.