Test Driven Documentation
Abstract
The generation of documents during software development is an expensive task and not addressed by several agile process. The task to synchronize the documentation and source code is a hard task. In this paper is presented an alternative to create User Document and Tests Specification by reusing functional tests. The approach is called Test Driven Documentation. In this work is also presented an experiment showing that this idea can decrease the effort spent during the document creation
Keywords:
Documentation, Directed, Tests
References
Capers, J. (2007). Estimating Software Costs: Bringing Realism to Estimating. McGraw-Hill, NewYork, NY, USA, 2ª edição.
IEEE (1998). IEEE Standard for Software Test Documentation – IEEE Std 829-1998. IEEE Computer Society.
IEEE (2001). IEEE Standard for Software User Documentation. IEEE Computer Society.
IEEE (2004). Guide to the Software Engineering Body of Knowledge. IEEE Computer Society, Los Alamitos, California.
Johnson, W. L. (1994). Dynamic (re)generation of software documentation. In: RMI-94-003, A.R.C.R., editor, Proceedings of the Fourth Systems Reengineering Technology Workshop, pages57–66, Monterey, California, USA. Johns Hopkins University Applied Physics Laboratory.
Jungmayr, S. e Stumpe, J. (1998). Another motivation for usage models: Generation of user documentation. In Proceedings of CONQUEST’98, Nüremberg, Alemanha.
Houaiss, A. e Villar, M. (2001). Dicionário Houaiss de língua portuguesa
Moriyon, R., Szekely, P. e Neches, R. (1994). Automatic generation of help from interface design models. In: CHI’94: Proceedings of the SIGCHI Conference on Human Factors in Computing Systems, pages 225–231, NewYork, NY, USA. ACM.
Padua,W. (2003). Engenharia de Software: Fundamentos, Métodos e Padrões. LTC, 2ª edição
Paris, C. e Linden, K. V. (1996). Building knowledge bases for the generation of software documentation. In: Proceedings of the 16th Conference on Computational Linguistics, pages734–739, Morristown, NJ, USA. Association for Computational Linguistics.
Reiter, E., Mellish, C. e Levine, J. (1992). Automatic generation of on-line documen tation in the idas project. In: Proceedings of the Third Conference on Applied Natural Language Processing, pages 64–71, Morristown, NJ, USA. Association for Computational Linguistics.
SOFTEX (2009). “MPS.BR - Guia Geral”, http://www.softex.br, Abril
Wohlin, C., Runeson, P., Host, M., Ohlsson, M., Regnell, B. e Wesslen, A. (2000). Experimentation in Software Engineering: An Introduction. Kluwer Academic Publishers.
IEEE (1998). IEEE Standard for Software Test Documentation – IEEE Std 829-1998. IEEE Computer Society.
IEEE (2001). IEEE Standard for Software User Documentation. IEEE Computer Society.
IEEE (2004). Guide to the Software Engineering Body of Knowledge. IEEE Computer Society, Los Alamitos, California.
Johnson, W. L. (1994). Dynamic (re)generation of software documentation. In: RMI-94-003, A.R.C.R., editor, Proceedings of the Fourth Systems Reengineering Technology Workshop, pages57–66, Monterey, California, USA. Johns Hopkins University Applied Physics Laboratory.
Jungmayr, S. e Stumpe, J. (1998). Another motivation for usage models: Generation of user documentation. In Proceedings of CONQUEST’98, Nüremberg, Alemanha.
Houaiss, A. e Villar, M. (2001). Dicionário Houaiss de língua portuguesa
Moriyon, R., Szekely, P. e Neches, R. (1994). Automatic generation of help from interface design models. In: CHI’94: Proceedings of the SIGCHI Conference on Human Factors in Computing Systems, pages 225–231, NewYork, NY, USA. ACM.
Padua,W. (2003). Engenharia de Software: Fundamentos, Métodos e Padrões. LTC, 2ª edição
Paris, C. e Linden, K. V. (1996). Building knowledge bases for the generation of software documentation. In: Proceedings of the 16th Conference on Computational Linguistics, pages734–739, Morristown, NJ, USA. Association for Computational Linguistics.
Reiter, E., Mellish, C. e Levine, J. (1992). Automatic generation of on-line documen tation in the idas project. In: Proceedings of the Third Conference on Applied Natural Language Processing, pages 64–71, Morristown, NJ, USA. Association for Computational Linguistics.
SOFTEX (2009). “MPS.BR - Guia Geral”, http://www.softex.br, Abril
Wohlin, C., Runeson, P., Host, M., Ohlsson, M., Regnell, B. e Wesslen, A. (2000). Experimentation in Software Engineering: An Introduction. Kluwer Academic Publishers.
Published
2010-06-07
How to Cite
SANTOS, Ismayle de Sousa; SANTOS NETO, Pedro de Alcântara dos; MOURA, Raimundo Santos; SOARES, André Castelo Branco.
Test Driven Documentation. In: BRAZILIAN SOFTWARE QUALITY SYMPOSIUM (SBQS), 9. , 2010, Belém.
Anais [...].
Porto Alegre: Sociedade Brasileira de Computação,
2010
.
p. 25-39.
DOI: https://doi.org/10.5753/sbqs.2010.15419.
