Skip to main content
zenodoopen

Dataset for "Information Correspondence between Types of Documentation for APIs"

<p>This online appendix contains the coding guide and the data used in the paper&nbsp;<em>Information Correspondence between Types of Documentation for APIs</em>&nbsp;accepted for publication in the&nbsp;<em>Empirical Software Engineering</em>&nbsp;(EMSE) journal. The tutorial data was retrieved in October 2018.</p> <p>It contains the following files:</p> <p>1.&nbsp;<strong>CodingGuide.pdf</strong>: the coding guide to classify a sentence as&nbsp;<em>API Information</em>&nbsp;or&nbsp;<em>Supporting Text</em>.</p> <p>2.&nbsp;<strong>annotated_sampled_sentences.csv</strong>: the set of 332 sampled sentences and two columns of corresponding annotations &ndash; one by the first author of this work and the second by an external annotator. This data was used to calculate the agreement score reported in the paper.</p> <p>3.&nbsp;<strong>&lt;language&gt;-&lt;topic&gt;.csv</strong>: the data set of annotated sentences in the tutorial on &lt;topic&gt; in &lt;language&gt;. For example Python-REGEX.csv&nbsp;is the file containing sentences from the Python tutorial on regular expressions. This file contains the preprocessed sentences from the tutorial, their source files, and their annotation of sentence correspondence with reference documentation.</p> <p>For licensing reasons, we are unable to upload the original API reference documentation and tutorials, however these are available on request.</p>

ShareScore

28/100

Overall dataset sharing score

Score breakdown

These five areas show where the dataset supports — or may limit — practical reuse.

Stewardship
8
Harmonization
4
Access
16
Reuse readiness
0
Engagement
0

Topics