Documentação de Software: Exploração dos problemas mais frequentes e qualidades mais relevantes

Abstract

The objective of this work was to carry out an exploratory research on the software documentation theme, to look for scientific articles that help getting to know the theme and to determine which are the most frequently faced problems by developers during the documentation activities. The motivation for carrying out this work was to determine which problems should be focused to make documentation development less laborious, as well as to determine which are the most important quality attributes of a software do cument. A bibliographic search was carried out to select relevant articles on the subject and then compare and compile the results of the most relevant articles. The most faced problems (incompleteness, ambiguity, incorrectness, obsolescence and lack of organiza tion), the problems considered most important (ambiguity, incompleteness, incorrectness, lack of examples and obsolescence), and the most important qualities (integrity, up-to dateness, legibility, usability and availability). Five hypotheses were also elaborated to be explored in future works.