Towards a documentation maturity model

This paper presents preliminary work towards a maturity model for system documentation. The Documentation Maturity Model (DMM) is specifically targeted towards assessing the quality of documentation used in aiding program understanding. Software engineers and technical writers produce such documentation during regular product development lifecycles. The documentation can also be recreated after the fact via reverse engineering. The DMM has both process and product components; this paper focuses on the product quality aspects.

[1]  Ian Sommerville,et al.  Software engineering (6th ed.) , 2001 .

[2]  Shihong Huang,et al.  Documenting software systems with views II: an integrated approach based on XML , 2001, SIGDOC '01.

[3]  Hausi A. Müller,et al.  Live documents with contextual, data-driven information components , 2002, SIGDOC '02.

[4]  David W. Binkley,et al.  Program slicing , 2008, 2008 Frontiers of Software Maintenance.

[5]  Taratip Suwannasart,et al.  Developing a Testing Maturity Model, Part II , 1996 .

[6]  Hausi A. Müller,et al.  Documenting software systems with views , 1992, SIGDOC '92.

[7]  Ralph Johnson,et al.  design patterns elements of reusable object oriented software , 2019 .

[8]  Watts S. Humphrey,et al.  Introduction to the Team Software Process , 1999 .

[9]  Michelle Carey,et al.  Developing Quality Technical Information: A Handbook for Writers and Editors , 2004 .

[10]  Paul Clements,et al.  Software architecture in practice , 1999, SEI series in software engineering.

[11]  Hausi A. Müller,et al.  Personalized information structures , 1993, SIGDOC '93.

[12]  William E. Hefley,et al.  The People Capability Maturity Model : guidelines for improving the workforce , 2002 .

[13]  James H. Cross,et al.  Reverse engineering and design recovery: a taxonomy , 1990, IEEE Software.

[14]  Mac H. McIntyre.  THE INTEGRATED PRODUCT DEVELOPMENT CAPABILITY MATURITY MODEL (CMM) SM , 1996 .

[15]  Shihong Huang,et al.  A qualitative assessment of the efficacy of UML diagrams as a form of graphical documentation in aiding program understanding , 2003, SIGDOC '03.

[16]  Shihong Huang,et al.  Documenting software systems with views III: towards a task-oriented classification of program visualization techniques , 2002, SIGDOC '02.

[17]  Michael Grüninger,et al.  Introduction , 2002, CACM.

[18]  Theo Mandel,et al.  Quality technical information: paving the way for usable print and web interface design , 2002, AJCD.

[19]  Scott R. Tilley,et al.  Automatically connecting documentation to code with rose , 2002, SIGDOC '02.

[20]  Mark C. Paulk,et al.  The Capability Maturity Model: Guidelines for Improving the Software Process , 1994 .

[21]  Jack Ferguson.  Software Acquisition Capability Maturity Model (SA-CMM) , 2002 .

[22]  Mary Beth Chrissis,et al.  CMMI: Guidelines for Process Integration and Product Improvement , 2003 .

[23]  Morris Dean,et al.  Producing quality technical information , 2002, AJCD.

[24]  Karl L. Smart,et al.  Assessing quality documents , 2002, AJCD.

[25]  Watts S. Humphrey,et al.  Introduction to the Personal Software Process , 1996 .

[26]  Kendall Scott,et al.  UML Explained , 2001 .

[27]  Anas N. Al-Rabadi,et al.  A comparison of modified reconstructability analysis and Ashenhurst‐Curtis decomposition of Boolean functions , 2004 .

[28]  Scott R. Tilley,et al.  The canonical activities of reverse engineering , 2000, Ann. Softw. Eng..

[29]  Hausi A. Müller,et al.  INFO: a simple document annotation facility , 1991, SIGDOC '91.