A comparative study of FAQs for software development

Mathias Ellmann, Irmo Timmann
{"title":"A comparative study of FAQs for software development","authors":"Mathias Ellmann, Irmo Timmann","doi":"10.1145/3340495.3342750","DOIUrl":null,"url":null,"abstract":"Developers use FAQs (Frequently Asked Questions) to access and share knowledge about software libraries, APIs, and platforms. This paper studies 2,660 questions from 43 FAQ websites. We analyzed accessibility metrics such as the steps from the main documentation page, tagging or multilingualism as well as structure and readability metrics such as code-to-text ratio, number of links, and Flesch Reading-Ease. In addition, we compared these FAQs to 69,548 Stack Overflow (SO) posts, which cover the same topics and which have been posted by developers at least twice (i.e. duplicates). Our results reveal that different software vendors give different importance to their FAQs, e.g. by investing more effort or less in structuring and presenting them. We found that studied FAQs include more references (e.g. to corresponding API documentation) and are more verbose and difficult to read than corresponding SO duplicates. We also found that FAQs cover additional topics compared to corresponding duplicate posts.","PeriodicalId":237309,"journal":{"name":"Proceedings of the 2nd ACM SIGSOFT International Workshop on Software Qualities and Their Dependencies","volume":"15 5 1","pages":"0"},"PeriodicalIF":0.0000,"publicationDate":"2019-08-26","publicationTypes":"Journal Article","fieldsOfStudy":null,"isOpenAccess":false,"openAccessPdf":"","citationCount":"1","resultStr":null,"platform":"Semanticscholar","paperid":null,"PeriodicalName":"Proceedings of the 2nd ACM SIGSOFT International Workshop on Software Qualities and Their Dependencies","FirstCategoryId":"1085","ListUrlMain":"https://doi.org/10.1145/3340495.3342750","RegionNum":0,"RegionCategory":null,"ArticlePicture":[],"TitleCN":null,"AbstractTextCN":null,"PMCID":null,"EPubDate":"","PubModel":"","JCR":"","JCRName":"","Score":null,"Total":0}
引用次数: 1

Abstract

Developers use FAQs (Frequently Asked Questions) to access and share knowledge about software libraries, APIs, and platforms. This paper studies 2,660 questions from 43 FAQ websites. We analyzed accessibility metrics such as the steps from the main documentation page, tagging or multilingualism as well as structure and readability metrics such as code-to-text ratio, number of links, and Flesch Reading-Ease. In addition, we compared these FAQs to 69,548 Stack Overflow (SO) posts, which cover the same topics and which have been posted by developers at least twice (i.e. duplicates). Our results reveal that different software vendors give different importance to their FAQs, e.g. by investing more effort or less in structuring and presenting them. We found that studied FAQs include more references (e.g. to corresponding API documentation) and are more verbose and difficult to read than corresponding SO duplicates. We also found that FAQs cover additional topics compared to corresponding duplicate posts.
软件开发常见问题的比较研究
开发人员使用faq(常见问题)来访问和共享有关软件库、api和平台的知识。本文研究了43个FAQ网站上的2660个问题。我们分析了可访问性指标,如从主文档页面开始的步骤、标记或多语言性,以及结构和可读性指标,如代码与文本比率、链接数量和文本阅读易用性。此外,我们将这些常见问题与69,548个Stack Overflow (SO)帖子进行了比较,这些帖子涵盖了相同的主题,并且至少被开发人员发布了两次(即重复)。我们的结果表明,不同的软件供应商对他们的faq给予不同的重视,例如,在构建和呈现它们方面投入更多或更少的努力。我们发现,研究过的faq包含了更多的参考资料(例如相应的API文档),并且比相应的SO副本更冗长,更难以阅读。我们还发现,与相应的重复帖子相比,faq涵盖了更多的主题。
本文章由计算机程序翻译,如有差异,请以英文原文为准。
求助全文
约1分钟内获得全文 求助全文
来源期刊
自引率
0.00%
发文量
0
×
引用
GB/T 7714-2015
复制
MLA
复制
APA
复制
导出至
BibTeX EndNote RefMan NoteFirst NoteExpress
×
提示
您的信息不完整,为了账户安全,请先补充。
现在去补充
×
提示
您因"违规操作"
具体请查看互助需知
我知道了
×
提示
确定
请完成安全验证×
copy
已复制链接
快去分享给好友吧!
我知道了
右上角分享
点击右上角分享
0
联系我们:info@booksci.cn Book学术提供免费学术资源搜索服务,方便国内外学者检索中英文文献。致力于提供最便捷和优质的服务体验。 Copyright © 2023 布克学术 All rights reserved.
京ICP备2023020795号-1
ghs 京公网安备 11010802042870号
Book学术文献互助
Book学术文献互助群
群 号:604180095
Book学术官方微信