Documenting Implementation Decisions with Code Annotations (bibtex)
by Hesse, Tom-Michael, Kuehlwein, Arthur, Paech, Barbara, Roehm, Tobias and Bruegge, Bernd
Abstract:
Software developers make various decisions when imple- menting software. For instance, they decide on how to im- plement an algorithm most efficiently or in which way to process user input. When code is revisited during mainte- nance, the underlying decisions need to be understood and possibly adjusted to the current situation. Common doc- umentation approaches like JavaDoc neither cover knowl- edge related to decisions explicitly, nor are they integrated closely with knowledge management. In consequence, de- cision knowledge is rarely documented and therefore inac- cessible, especially when developers have left the team. So, effective maintenance is hindered. We have developed an annotation model for decision knowledge and integrated it with the knowledge management tool UNICASE. The ap- proach enables developers to document decisions within code without tool switches to lower their documentation ef- fort. Afterwards, maintainers can exploit the embedded de- cision knowledge and follow links to external knowledge. This paper presents the approach and evaluation results of a first case study, which indicate its practicability.
Reference:
Documenting Implementation Decisions with Code Annotations (Hesse, Tom-Michael, Kuehlwein, Arthur, Paech, Barbara, Roehm, Tobias and Bruegge, Bernd), In Proceedings of the 27th International Conference on Software Engineering and Knowledge Engineering (SEKE'15), KSI Research Inc., 2015.
Bibtex Entry:
@inproceedings{Hesse2015,
abstract = {Software developers make various decisions when imple- menting software. For instance, they decide on how to im- plement an algorithm most efficiently or in which way to process user input. When code is revisited during mainte- nance, the underlying decisions need to be understood and possibly adjusted to the current situation. Common doc- umentation approaches like JavaDoc neither cover knowl- edge related to decisions explicitly, nor are they integrated closely with knowledge management. In consequence, de- cision knowledge is rarely documented and therefore inac- cessible, especially when developers have left the team. So, effective maintenance is hindered. We have developed an annotation model for decision knowledge and integrated it with the knowledge management tool UNICASE. The ap- proach enables developers to document decisions within code without tool switches to lower their documentation ef- fort. Afterwards, maintainers can exploit the embedded de- cision knowledge and follow links to external knowledge. This paper presents the approach and evaluation results of a first case study, which indicate its practicability.},
author = {Hesse, Tom-Michael and Kuehlwein, Arthur and Paech, Barbara and Roehm, Tobias and Bruegge, Bernd},
booktitle = {Proceedings of the 27th International Conference on Software Engineering and Knowledge Engineering (SEKE'15)},
doi = {10.18293/SEKE2015-084},
isbn = {1891706373},
issn = {23259086},
keywords = {ures},
mendeley-tags = {ures},
pages = {152 -- 157},
publisher = {KSI Research Inc.},
title = {{Documenting Implementation Decisions with Code Annotations}},
year = {2015}
}
Powered by bibtexbrowser