Document (#41576)

Author: Li, J.
Sun, A.
Xing, Z.
Title: To do or not to do : distill crowdsourced negative caveats to augment api documentation
Source: Journal of the Association for Information Science and Technology. 69(2018) no.12, S.1460-1475
Year: 2018
Abstract: Negative caveats of application programming interfaces (APIs) are about "how not to use an API," which are often absent from the official API documentation. When these caveats are overlooked, programming errors may emerge from misusing APIs, leading to heavy discussions on Q&A websites like Stack Overflow. If the overlooked caveats could be mined from these discussions, they would be beneficial for programmers to avoid misuse of APIs. However, it is challenging because the discussions are informal, redundant, and diverse. For this, for example, we propose Disca, a novel approach for automatically Distilling desirable API negative caveats from unstructured Q&A discussions. Through sentence selection and prominent term clustering, Disca ensures that distilled caveats are context-independent, prominent, semantically diverse, and nonredundant. Quantitative evaluation in our experiments shows that the proposed Disca significantly outperforms four text-summarization techniques. We also show that the distilled API negative caveats could greatly augment API documentation through qualitative analysis.
Content: https://onlinelibrary.wiley.com/doi/10.1002/asi.24067.

Similar documents (content)

Tang, L.; Hu, G.; Liu, W.: Funding acknowledgment analysis : queries and caveats (2017) 0.24

0.23692358 = sum of:
  0.23692358 = product of:
    2.9615448 = sum of:
      0.011197888 = weight(abstract_txt:from in 3442) [ClassicSimilarity], result of:
        0.011197888 = score(doc=3442,freq=1.0), product of:
          0.037042342 = queryWeight, product of:
            1.5454515 = boost
            2.7638826 = idf(docFreq=7577, maxDocs=44218)
            0.008672084 = queryNorm
          0.30229968 = fieldWeight in 3442, product of:
            1.0 = tf(freq=1.0), with freq of:
              1.0 = termFreq=1.0
            2.7638826 = idf(docFreq=7577, maxDocs=44218)
            0.109375 = fieldNorm(doc=3442)
      2.950347 = weight(title_txt:caveats in 3442) [ClassicSimilarity], result of:
        2.950347 = score(doc=3442,freq=1.0), product of:
          0.80685157 = queryWeight, product of:
            9.541617 = boost
            9.7509775 = idf(docFreq=6, maxDocs=44218)
            0.008672084 = queryNorm
          3.6566167 = fieldWeight in 3442, product of:
            1.0 = tf(freq=1.0), with freq of:
              1.0 = termFreq=1.0
            9.7509775 = idf(docFreq=6, maxDocs=44218)
            0.375 = fieldNorm(doc=3442)
    0.08 = coord(2/25)

Leydesdorff, L.: Caveats for the use of citation indicators in research and journal evaluations (2008) 0.16

0.1579917 = sum of:
  0.1579917 = product of:
    1.9748963 = sum of:
      0.007998491 = weight(abstract_txt:from in 1361) [ClassicSimilarity], result of:
        0.007998491 = score(doc=1361,freq=1.0), product of:
          0.037042342 = queryWeight, product of:
            1.5454515 = boost
            2.7638826 = idf(docFreq=7577, maxDocs=44218)
            0.008672084 = queryNorm
          0.21592833 = fieldWeight in 1361, product of:
            1.0 = tf(freq=1.0), with freq of:
              1.0 = termFreq=1.0
            2.7638826 = idf(docFreq=7577, maxDocs=44218)
            0.078125 = fieldNorm(doc=1361)
      1.9668978 = weight(title_txt:caveats in 1361) [ClassicSimilarity], result of:
        1.9668978 = score(doc=1361,freq=1.0), product of:
          0.80685157 = queryWeight, product of:
            9.541617 = boost
            9.7509775 = idf(docFreq=6, maxDocs=44218)
            0.008672084 = queryNorm
          2.4377444 = fieldWeight in 1361, product of:
            1.0 = tf(freq=1.0), with freq of:
              1.0 = termFreq=1.0
            9.7509775 = idf(docFreq=6, maxDocs=44218)
            0.25 = fieldNorm(doc=1361)
    0.08 = coord(2/25)

Curran, G.L.: Inmagic: Kudos and caveats (1986) 0.16

0.15735182 = sum of:
  0.15735182 = product of:
    3.9337957 = sum of:
      3.9337957 = weight(title_txt:caveats in 5601) [ClassicSimilarity], result of:
        3.9337957 = score(doc=5601,freq=1.0), product of:
          0.80685157 = queryWeight, product of:
            9.541617 = boost
            9.7509775 = idf(docFreq=6, maxDocs=44218)
            0.008672084 = queryNorm
          4.8754888 = fieldWeight in 5601, product of:
            1.0 = tf(freq=1.0), with freq of:
              1.0 = termFreq=1.0
            9.7509775 = idf(docFreq=6, maxDocs=44218)
            0.5 = fieldNorm(doc=5601)
    0.04 = coord(1/25)

Schneider, K.G.: Cataloging Internet resources : concerns and caveats (1997) 0.12

0.11801387 = sum of:
  0.11801387 = product of:
    2.950347 = sum of:
      2.950347 = weight(title_txt:caveats in 7904) [ClassicSimilarity], result of:
        2.950347 = score(doc=7904,freq=1.0), product of:
          0.80685157 = queryWeight, product of:
            9.541617 = boost
            9.7509775 = idf(docFreq=6, maxDocs=44218)
            0.008672084 = queryNorm
          3.6566167 = fieldWeight in 7904, product of:
            1.0 = tf(freq=1.0), with freq of:
              1.0 = termFreq=1.0
            9.7509775 = idf(docFreq=6, maxDocs=44218)
            0.375 = fieldNorm(doc=7904)
    0.04 = coord(1/25)

McCain, K.W.: Assessing obliteration by incorporation : issues and caveats (2012) 0.12

0.11801387 = sum of:
  0.11801387 = product of:
    2.950347 = sum of:
      2.950347 = weight(title_txt:caveats in 485) [ClassicSimilarity], result of:
        2.950347 = score(doc=485,freq=1.0), product of:
          0.80685157 = queryWeight, product of:
            9.541617 = boost
            9.7509775 = idf(docFreq=6, maxDocs=44218)
            0.008672084 = queryNorm
          3.6566167 = fieldWeight in 485, product of:
            1.0 = tf(freq=1.0), with freq of:
              1.0 = termFreq=1.0
            9.7509775 = idf(docFreq=6, maxDocs=44218)
            0.375 = fieldNorm(doc=485)
    0.04 = coord(1/25)