ARTÍCULO
TITULO

Approaches for Documentation in Continuous Software Development

Theo Theunissen    
Stijn Hoppenbrouwers    
Sietse Overbeek    

Resumen

It is common practice for practitioners in industry as well as for ICT/CS students to keep writing ? and reading ­? about software products to a bare minimum. However, refraining from documentation may result in severe issues concerning the vaporization of knowledge regarding decisions made during the phases of design, build, and maintenance.  In this article, we distinguish between knowledge required upfront to start a project or iteration, knowledge required to complete a project or iteration, and knowledge required to operate and maintain software products. With `knowledge', we refer to actionable information. We propose three approaches to keep up with modern development methods to prevent the risk of knowledge vaporization in software projects. These approaches are `Just Enough Upfront' documentation, `Executable Knowledge', and `Automated Text Analytics' to help record, substantiate, manage and retrieve design decisions in the aforementioned phases. The main characteristic of `Just Enough Upfront' documentation is that knowledge required upfront includes shaping thoughts/ideas, a codified interface description between (sub)systems, and a plan. For building the software and making maximum use of progressive insights, updating the specifications is sufficient. Knowledge required by others to use, operate and maintain the product includes a detailed design and accountability of results. `Executable Knowledge' refers to any executable artifact except the source code. Primary artifacts include Test Driven Development methods and infrastructure-as-code, including continuous integration scripts. A third approach concerns `Automated Text Analysis' using Text Mining and Deep Learning to retrieve design decisions.

 Artículos similares

       
 
Jimmy Molina Ríos and Nieves Pedreira-Souto    
The current inclusion of agile methodologies in web-oriented projects has been considered on a large-scale by software developers. However, the benefits and limitations go beyond the comforts that project managers delimit when choosing them. Selecting a ... ver más
Revista: Information

 
Raffaele Albano    
Three-dimensional (3D) reconstruction techniques are increasingly used to obtain 3D representations of buildings due to the broad range of applications for 3D city models related to sustainability, efficiency and resilience (i.e., energy demand estimatio... ver más
Revista: Applied Sciences

 
Irima Campillo Torres Irima,Idalmis Cabrera Morales Idalmis Maria    
Hoy día la gestión eficaz de los recursos de información y documentación en las empresas, genera la búsqueda de soluciones prácticas y exitosas. El presente artículo aborda el papel fundamental que han tenido los archivos, desde la antigüedad hasta la ac... ver más