Methodology for Software Documentation Reuse

Abstract

This paper describes a documentation writing methodology developed and used by the author to address some of the issues of consistency in documentation and product function, redundancy of research and solution, and product usability (including timeliness of delivery and quality of support) for a software product engineered, developed and deployed in a multi-organizational or corporate environment. The methodology is compatible with technical systems engineering, development and testing documentation requirements, and is applicable to software products for which there are existing or anticipated “user guides”. The method used to accomplish these goals is the incorporation of existing user guide formats, wherever possible, in the documentation of technical specifications for detailed engineering, development and testing requirements. This paper describes the “cycle of documentation” methodology employed, identifies opportunities to use this methodology, and describes some of the benefits derived from using the methodology (both initially intended and later discovered).