Scientific and Technical Journal


ISSN Print 2221-3937
ISSN Online 2221-3805

With software being all around us, it is surprising how little the documentation of it has developed during the last decades. Software system documentation is however most critical during maintenance tasks, where tremendous amounts of time are spend understanding the software and its documentation, before the actual maintenance work can start. This paper gives a status of current documentation practices as well as a view on its quality. The purpose of this paper is to create a discussion about those practices to foster ideas for the future.


1. Beedle M., Bennekum A.V., Cockburn A., and others, (2001). The Agile Manifesto, http:// (accessed: 01.03.2014).

2. Dolan T, Weterings R., and Wortmann J.C. (1998), Stakeholders in Software-System Family Architectures, in: Proceedings of the 2nd International Esprit ARES Workshop, Las Palmas de Gran Canaria, Spain, (27.02.1998).

3. Dzidek J.W., Arisholm E., and Briand L.C. (2008).  A realistic Empirical Evaluation of the cost and Benefits of UML in Software Maintenance, in: IEEE Transactions on Software Engineering, Vol. 34, No. 3.

4. Ford P. The Obamacare Website Didn't Have to Fail. How to Do Better Next Time. Bloomberg Businessweek, (accessed: 16.10.2013).

5. Gacek C., Abd-Allah A., Bradford C., and Boehm B. (1995), On the Definition of Software System Architecture, in: ICSE 17th Software Architecture Workshop, April 1995.

6. IEEE Standard 610.12:1990, Glossary of Software Engineering Terminology.

7. ISO/IEC/IEEE. Defining Architecture, (accessed: 28.02.2014).

8. Kajko-Mattsson M. (2005). A Survey of Documentation Practice within Corrective Maintenance, in: Empirical Software Engineering, 10, pp. 31 – 55.

9. Parnas D.L.. (1994). Software aging, in: Proceedings of the 16th International Conference of Software Engineering. pp. 279–287.

10. Pfleegwe S.L. (2001), Software Engineering – Theory and Practice.

11. Pigoski T.M. (1996). Practical Software Maintenance – Best Practices for Software Investments.

12. Schreck D., Dallmeier V., Zimmermann T. (2007). How Documentation Evolves Over Time, in: Proceedings of the ACM IWPSE 2007.

13. Seacord R.C., Plakosh D., and Lewis G.A. (2003). Modernizing Legacy Systems – Software Ttechnologies, Engineering Proces-ses and Business Practices.

14. Wojciech D.J., Arisholm E., and Briand L.C. A Realistic Empirical Evaluation of the costs and Benefits of UML in Software Maintenance.

15. Souza S.C.B., Anquetil N., and Oliveira K.M. (2005). A Study of the Docu-mentation Essential to Software Maintenance, in: Proceedings to ACM SIGDOC 2005.

16. Stettina C.J., and Kroon E. (2013). Is there an agile Handover? Findings from an Empirical Study on Documentation and Handover Practices Across Agile Project Teams, in: Proceeding of 2013 IEEE International Technology Management Conference & 19th ICE Conference 2013.

17. Tilley S.R., Müller H.A., and Orgun M.A. Documenting Software Systems with views, in: Proceedings of the 10th annual International Conference on System Documentation (SIGDOC), Ottawa, ON, Canada, 1992, pp. 211 – 219.

18. Visconti M., and Cook C.R. (1993). A Software System Documentation Process Maturity Approach to Software Quality, in: Proceedings of the 11th Pacific Northwest Software Quality Conference, 1993, pp. 257 – 271.

19. Visconti M., and Cook C.R. (2002). An Overview of Industrial Software Documentation Practices, in Proceedings of the 12th IEEE International Conference of Chilean Computer Science Society, 179 – 186.

20. Wingkvist A., Ericson M., Lincke R., and Löwe W. (2010), A Metrics-based Approach to Technical Documentation Quality, in: Proceedings of the 7th International Conference of Information and Communication Technology.

Last download:
13 Jan 2020

[ © KarelWintersky ] [ All articles ] [ All authors ]
[ © Odessa National Polytechnic University, 2014-2018. Any use of information from the site is possible only under the condition that the source link! ]