Crowdsourcing Scientific Software Documentation: A Case Study of the NumPy Documentation Project
Authors:
- 15 August 2014
- journal article
- Published by Institute of Electrical and Electronics Engineers (IEEE) in Computing in Science & Engineering
- Vol. 17 (1) , 28-36
Abstract
Without good documentation, even the most sophisticated and efficient scientific software is difficult to use and maintain. However, due to lack of time, resources, and incentives, scientists who develop software for other scientists aren't keen on writing documentation. Scientific software packages that are freely available and shared within scientific communities often suffer from poor documentation, sometimes making them unusable. This article considers documentation crowdsourcing as a way to address the issue. Using the NumPy documentation project as a case study, the article discusses how to leverage the knowledge about software that resides within the user community. The research looks at technical infrastructure, community engagement, and motivation, and considers benefits, such as expanding the community, and challenges, including maintaining commitment level. The conclusion suggests preliminary guidelines for those thinking about documentation crowdsourcing.Keywords
This publication has 8 references indexed in Scilit:
- Troubling Trends in Scientific Software UseScience, 2013
- Git can facilitate greater reproducibility and increased transparency in scienceSource Code for Biology and Medicine, 2013
- Documentation practices in scientific software development2012
- Scientific software production2011
- A survey of scientific software development2010
- Some Problems of Professional End User Developers2007
- When Software Engineers Met Research Scientists: A Case StudyEmpirical Software Engineering, 2005
- How software engineers use documentation: the state of the practiceIEEE Software, 2003