Understanding How Programmers Can Use Annotations on Documentation
Understanding How Programmers Can Use Annotations on Documentation
复制标题
了解程序员如何在文档上使用注释
DOI：
10.1145/3491102.3502095
复制
发表时间：
2022
期刊：
影响因子：
--
通讯作者：
Myers, Brad A
中科院分区：
文献类型：
--
作者：
Horvath, Amber;Liu, Michael Xieyang;Hendriksen, River;Shannon, Connor;Paterson, Emma;Jawad, Kazi;Macvean, Andrew;Myers, Brad A
现代软件开发要求开发人员找到并有效利用新的API及其文档，但文档存在许多众所周知的问题。尽管如此，开发人员最终还是克服了这些问题，但没有办法分享他们学到的东西。我们研究通过注释共享特定于文档的信息，与开发人员论坛相比，注释具有优势，因为信息是上下文的，不是破坏性的，而且很简短，因此很容易创作。开发人员还可以编写注释来支持他们自己的理解。为了支持我们发现的文档使用行为，我们构建了Adamite注释工具，它提供了多个锚点、注释类型和固定等功能。在我们的用户研究中，我们发现开发人员能够创建对自己有用的注释，并且能够在学习新API时利用其他开发人员创建的注释，注释的读者平均比基线多完成67%的任务。
Modern software development requires developers to find and effectively utilize new APIs and their documentation, but documentation has many well-known issues. Despite this, developers eventually overcome these issues but have no way of sharing what they learned. We investigate sharing this documentation-specific information through annotations, which have advantages over developer forums as the information is contextualized, not disruptive, and is short, thus easy to author. Developers can also author annotations to support their own comprehension. In order to support the documentation usage behaviors we found, we built the Adamite annotation tool, which provides features such as multiple anchors, annotation types, and pinning. In our user study, we found that developers are able to create annotations that are useful to themselves and are able to utilize annotations created by other developers when learning a new API, with readers of the annotations completing 67% more of the task, on average, than the baseline.
登录
查看更多内容
开发人员如何使用 API 文档：观察研究
DOI：
--
发表时间：
2019
期刊：
CDQR
影响因子：
--
作者：
Michael Meng;Stephanie M. Steinhardt;Andreas Schubert
通讯作者：
Andreas Schubert
NoteCoStruct：通过社交支架笔记记录和共享为在线学习者提供支持
DOI：
--
发表时间：
2021
期刊：
CHI Extended Abstracts
影响因子：
--
作者：
Jingchao Fang;Yanhao Wang;Chi;Hao
通讯作者：
Hao
影响因子：
3.8
作者：
M. Guzdial;J. Turns
通讯作者：
M. Guzdial;J. Turns
API 学习者心智模型研究方法
DOI：
--
发表时间：
2019
期刊：
CHI Extended Abstracts
影响因子：
--
作者：
Amber Horvath;Mariann Nagy;Finn Voichick;Mary Beth Kery;B. Myers
通讯作者：
B. Myers
程序员的实证研究：第五次研讨会：在第五届程序员实证研究研讨会上发表的论文，1993 年 12 月 3-5 日，加利福尼亚州帕洛阿尔托
DOI：
--
发表时间：
1993
期刊：
影响因子：
--
作者：
C. Cook;J. Scholtz;J. Spohrer
通讯作者：
J. Spohrer