Creating and evolving developer documentation
Title | Creating and evolving developer documentation |
Publication Type | Conference Paper |
Year of Publication | 2010 |
Authors | Dagenais, B, Robillard, MP |
Refereed Designation | Refereed |
Tertiary Authors | Roman, G-C, van der Hoek, A |
Secondary Title | Proceedings of the eighteenth ACM SIGSOFT international symposium |
Pagination | 127 |
Publisher | ACM Press |
Place Published | Santa Fe, New Mexico, USANew York, New York, USA |
ISBN Number | 9781605587912 |
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. |
DOI | 10.1145/1882291.1882312 |
Full Text |
- Log in or register to post comments
- Google Scholar
- DOI
- BibTeX
- Tagged
- EndNote XML