A importância da documentação no processo de desenvolvimento de sistemas

Abstract

A Documentação de sistemas é um aspecto importante nos projetos e na Engenharia de Software em geral. De fato, o processo de documentação se tornou um subdomínio popular na comunidade de Engenharia de Sistema. Infelizmente, a percepção atual da documentação é que está desatualizada, irrelevante e incompleto. Para a maior parte, essa percepção é provavelmente verdadeira. Lamentavelmente, a questão da documentação não pode ser resolvida simplesmente exigindo mais documentação. Essa abordagem falha na solução do problema, pois a mesma ignora os objetivos fundamentais da Engenharia de Software. O papel da documentação em um ambiente de Engenharia de Software é comunicar informações ao seu público e transmitir conhecimento do sistema que descreve. Uma solução projetada para o problema da documentação seria a alocação de recursos apropriados para documentar o conhecimento adequado sobre o sistema, na medida em que o desenvolvimento atual e o futuro se beneficiarão de maneira ideal. No entanto, sequer entendemos completamente o impacto da documentação no desenvolvimento atual e futuro, nem os aspectos da documentação que contribuem para sua capacidade de comunicação eficaz. Realmente, não sabemos até que ponto devemos documentar para equilibrar as compensações entre alocar muito recursos para documentação que dificultam o desenvolvimento atual, ou não alocar recursos suficientes e dificultar o desenvolvimento futuro. Entretanto, aumentar os recursos da documentação não melhora necessariamente o desenvolvimento do sistema futuro, uma vez que, não entendemos realmente o que define a qualidade da documentação. Este trabalho apresenta a problemática que envolve a documentação considerando-se as diversas abordagens metodológicas, enfatizando as questões que reforçam a sua importância no contexto do processo de desenvolvimento de sistemas.

Systems documentation is an important aspect of projects and Software Engineering in general. In fact, the documentation process has become a popular subdomain in the System Engineering community. Unfortunately, the current perception of the documentation is that it is outdated, irrelevant and incomplete. For the most part, this perception is probably true. Unfortunately, the documentation issue cannot be resolved simply by requiring more documentation. This approach fails to solve the problem, as it ignores the fundamental objectives of Software Engineering. The role of documentation in a Software Engineering environment is to communicate information to your audience and convey knowledge of the system it describes. A designed solution to the documentation problem would be to allocate appropriate resources to document adequate knowledge about the system, as current and future development will ideally benefit. However, we do not even fully understand the impact of documentation on current and future development, nor the aspects of documentation that contribute to its ability to communicate effectively. We really don't know how far we should document to balance the trade-offs between allocating too much documentation resources that hinder current development, or not allocating enough resources and hindering future development. However, increasing the resources of the documentation does not necessarily improve the development of the future system, since we do not really understand what defines the quality of the documentation. This work presents the problem that involves documentation considering the different methodological approaches, emphasizing the issues that reinforce its importance in the context of the systems development process.