A documentation suite for maintenance programmers

A documentation approach has been developed to accelerate the productivity of maintenance programmers (MPs). The documentation approach takes into account that the MP's level of understanding changes as more experience is gained. Four learning stages have been identified: newcomer, student, intern and expert. Both the type of information and the form in which it is presented differs, depending upon the MP's learning stage. MPs in the four stages receive respectively contextual overviews, design stories, task-oriented manuals and reference materials. This documentation approach has been used at U.S. Army TARDEC to develop a documentation suite for a software module serving as the core of ground vehicle simulation software for the Vetronics Simulation Facility. The authors describe the documentation suite and what they have learned over the past two years developing and using it.