Creating and evolving developer documentation: understanding the decisions of open source contributors
B. Dagenais, and M. Robillard. Proceedings of the eighteenth ACM SIGSOFT international symposium on Foundations of software engineering, page 127--136. New York, NY, USA, ACM, (2010)
DOI: 10.1145/1882291.1882312
Abstract
Developer documentation helps developers learn frameworks and libraries. To better understand how documentation in open source projects is created and maintained, we performed a qualitative study in which we interviewed core contributors who wrote developer documentation and developers who read documentation. In addition, we studied the evolution of 19 documents by analyzing more than 1500 document revisions. We identified the decisions that contributors make, the factors influencing these decisions and the consequences for the project. Among many findings, we observed how working on the documentation could improve the code quality and how constant interaction with the projects' community positively impacted the documentation.
%0 Conference Paper
%1 Dagenais:2010:CED:1882291.1882312
%A Dagenais, Barthélémy
%A Robillard, Martin P.
%B Proceedings of the eighteenth ACM SIGSOFT international symposium on Foundations of software engineering
%C New York, NY, USA
%D 2010
%I ACM
%K documentation reticollab1112 wiki
%P 127--136
%R 10.1145/1882291.1882312
%T Creating and evolving developer documentation: understanding the decisions of open source contributors
%U http://doi.acm.org/10.1145/1882291.1882312
%X Developer documentation helps developers learn frameworks and libraries. To better understand how documentation in open source projects is created and maintained, we performed a qualitative study in which we interviewed core contributors who wrote developer documentation and developers who read documentation. In addition, we studied the evolution of 19 documents by analyzing more than 1500 document revisions. We identified the decisions that contributors make, the factors influencing these decisions and the consequences for the project. Among many findings, we observed how working on the documentation could improve the code quality and how constant interaction with the projects' community positively impacted the documentation.
%@ 978-1-60558-791-2
@inproceedings{Dagenais:2010:CED:1882291.1882312,
abstract = {Developer documentation helps developers learn frameworks and libraries. To better understand how documentation in open source projects is created and maintained, we performed a qualitative study in which we interviewed core contributors who wrote developer documentation and developers who read documentation. In addition, we studied the evolution of 19 documents by analyzing more than 1500 document revisions. We identified the decisions that contributors make, the factors influencing these decisions and the consequences for the project. Among many findings, we observed how working on the documentation could improve the code quality and how constant interaction with the projects' community positively impacted the documentation.},
acmid = {1882312},
added-at = {2011-10-04T13:49:49.000+0200},
address = {New York, NY, USA},
author = {Dagenais, Barth{\'e}l{\'e}my and Robillard, Martin P.},
biburl = {https://www.bibsonomy.org/bibtex/2ae75825c3c30a1710a46093f6cae950a/lanubile},
booktitle = {Proceedings of the eighteenth ACM SIGSOFT international symposium on Foundations of software engineering},
description = {Creating and evolving developer documentation},
doi = {10.1145/1882291.1882312},
interhash = {432f1eafe5fa6805d2e75232cae054ab},
intrahash = {ae75825c3c30a1710a46093f6cae950a},
isbn = {978-1-60558-791-2},
keywords = {documentation reticollab1112 wiki},
location = {Santa Fe, New Mexico, USA},
numpages = {10},
pages = {127--136},
publisher = {ACM},
series = {FSE '10},
timestamp = {2011-10-04T13:49:49.000+0200},
title = {Creating and evolving developer documentation: understanding the decisions of open source contributors},
url = {http://doi.acm.org/10.1145/1882291.1882312},
year = 2010
}