Sentence examples for crowd documentation from inspiring English sources
The interaction of developers on the Web, on the other hand, generates content concerning APIs from different perspectives, which can be used to document APIs, also known as crowd documentation.
Crowd documentation may not be a complete substitute for official documentation because of its partial coverage, especially for how-to-do-it tasks.
The statement did not specify what would constitute a violation, though other UEFA documentation defines crowd disturbances broadly, including actions ranging from fighting to throwing objects to disrupting national anthems to "the use of gestures, words, objects or any other means to transmit any message that is not fit for a sports event".
They claimed that a high coverage would suggest that it is feasible to use the crowd knowledge for API documentation as a comprehensive source of knowledge concerning an API.
It's Larry Clark's Tulsa reborn via self-documentation and crowd participation.
They also concluded that despite the potential of a documentation by the crowd to provide many examples and explanations on API elements, the crowd is not reliable for providing content over an entire API.
This result may impose further warnings on the use of crowd knowledge depending on the documentation intent.
Our main goal is to understand how the crowd can contribute for API documentation on two programming tasks: how to implement a scenario using an API (how-to-do-it), and how to fix domain-independent bugs in an existing code where there was a misunderstanding regarding the usage of an API (debug-corrective).
Regarding overall coverage of an API, poor coverage may suggest that it is not feasible to use the crowd knowledge for generating an API documentation as a substitute for official documentation.
It may suggest that widely used parts of an API require many documentation details that the crowd can address much more easily than the official documentation.
To investigate the feasibility of using crowd knowledge on Stack Overflow for API documentation, Parnin et al. [8] carried out a study on how content related to a set of APIs is being produced on Stack Overflow.
