English
Related papers

Related papers: Requirements of API Documentation: A Case Study in…

200 papers

Data is central to the development and evaluation of machine learning (ML) models. However, the use of problematic or inappropriate datasets can result in harms when the resulting models are deployed. To encourage responsible AI practice…

Human-Computer Interaction · Computer Science 2022-08-25 Amy K. Heger , Liz B. Marquis , Mihaela Vorvoreanu , Hanna Wallach , Jennifer Wortman Vaughan

Given a large and evolving codebase, the ability to automatically generate holistic, architecture-aware documentation that captures not only individual functions but also cross-file, cross-module, and system-level interactions remains an…

Software Engineering · Computer Science 2026-04-07 Anh Nguyen Hoang , Minh Le-Anh , Bach Le , Nghi D. Q. Bui

The rapid proliferation of AI models has underscored the importance of thorough documentation, as it enables users to understand, trust, and effectively utilize these models in various applications. Although developers are encouraged to…

Software Engineering · Computer Science 2024-02-09 Weixin Liang , Nazneen Rajani , Xinyu Yang , Ezinwanne Ozoani , Eric Wu , Yiqun Chen , Daniel Scott Smith , James Zou

[Context] Artificial intelligence (AI) components used in building software solutions have substantially increased in recent years. However, many of these solutions focus on technical aspects and ignore critical human-centered aspects.…

Software Engineering · Computer Science 2023-05-22 Khlood Ahmad , Mohamed Abdelrazek , Chetan Arora , Arbind Agrahari Baniya , Muneera Bano , John Grundy

Software developers are increasingly using machine learning APIs to implement 'intelligent' features. Studies show that incorporating machine learning into an application increases technical debt, creates data dependencies, and introduces…

Software Engineering · Computer Science 2020-05-28 Maheswaree K Curumsing , Alex Cummaudo , Ulrike Maria Graetsch , Scott Barnett , Rajesh Vasa

Software documentation guides the proper use of tools or services. With the rapid growth of machine learning libraries, individuals from various fields are incorporating machine learning into their workflows through programming. However,…

Software Engineering · Computer Science 2025-05-06 Sharuka Promodya Thirimanne , Elim Yoseph Lemango , Giulio Antoniol , Maleknaz Nayebi

Most application development happens in the context of complex APIs; reference documentation for APIs has grown tremendously in variety, complexity, and volume, and can be difficult to navigate. There is a growing need to develop…

Software Engineering · Computer Science 2016-07-27 Niraj Kumar , Premkumar Devanbu

[Background] In large open-source software projects, development knowledge is often fragmented across multiple artefacts and contributors such that individual stakeholders are generally unaware of the full breadth of the product features.…

Software Engineering · Computer Science 2024-08-05 Tim Puhlfürß , Lloyd Montgomery , Walid Maalej

Dataset documentation is widely recognized as essential for the responsible development of automated systems. Despite growing efforts to support documentation through different kinds of artifacts, little is known about the motivations…

Software Engineering · Computer Science 2026-02-19 Pedro Reynolds-Cuéllar , Marisol Wong-Villacres , Adriana Alvarado Garcia , Heila Precel

Developers prefer to utilize third-party libraries when they implement some functionalities and Application Programming Interfaces (APIs) are frequently used by them. Facing an unfamiliar API, developers tend to consult tutorials as…

Software Engineering · Computer Science 2017-03-07 He Jiang , Jingxuan Zhang , Xiaochen Li , Zhilei Ren , David Lo

Application Programming Interfaces (APIs), which encapsulate the implementation of specific functions as interfaces, greatly improve the efficiency of modern software development. As numbers of APIs spring up nowadays, developers can hardly…

Software Engineering · Computer Science 2021-12-24 Yun Peng , Shuqing Li , Wenwei Gu , Yichen Li , Wenxuan Wang , Cuiyun Gao , Michael Lyu

In addition to their vital role in professional software development, Application Programming Interfaces (APIs) are now increasingly used by non-professional programmers, including end users, scientists and experts from other domains.…

When learning to use an Application Programming Interface (API), programmers need to understand the inputs and outputs (I/O) of the API functions. Current documentation tools automatically document the static information of I/O, such as…

Software Engineering · Computer Science 2018-08-21 Siyuan Jiang , Ameer Armaly , Collin McMillan , Qiyu Zhi , Ronald Metoyer

Web APIs may have constraints on parameters, such that not all parameters are either always required or always optional. Moreover, the presence or value of one parameter could cause another parameter to be required, or parameters could have…

Software Engineering · Computer Science 2021-02-02 Henk Grent , Aleksei Akimov , Maurício Aniche

Operationalizing the EU AI Act requires clear technical documentation to ensure AI systems are transparent, traceable, and accountable. Existing documentation templates for AI systems do not fully cover the entire AI lifecycle while meeting…

Machine Learning · Computer Science 2025-08-13 Laura Lucaj , Alex Loosley , Hakan Jonsson , Urs Gasser , Patrick van der Smagt

Development of machine learning (ML) applications is hard. Producing successful applications requires, among others, being deeply familiar with a variety of complex and quickly evolving application programming interfaces (APIs). It is…

Software Engineering · Computer Science 2022-03-30 Lars Reimann , Günter Kniesel-Wünsche

Understanding and analyzing big data is firmly recognized as a powerful and strategic priority. For deeper interpretation of and better intelligence with big data, it is important to transform raw data (unstructured, semi-structured and…

Information Retrieval · Computer Science 2016-12-13 Seyed-Mehdi-Reza Beheshti , Alireza Tabebordbar , Boualem Benatallah , Reza Nouri

Documentation plays a crucial role in both external accountability and internal governance of AI systems. Although there are many proposals for documenting AI data, models, systems, and methods, the ways these practices enhance governance…

Human-Computer Interaction · Computer Science 2024-12-11 Amy A. Winecoff , Miranda Bogen

Context: Agile development methodologies in the software industry have increased significantly over the past decade. Although one of the main aspects of agile software development (ASD) is less documentation, there have always been…

Software Engineering · Computer Science 2023-04-18 Md Athikul Islam , Rizbanul Hasan , Nasir U. Eisty

Software Documentation plays a major role in the usage and development of a project. Widespread adoption of open source software projects contributes to larger and faster development of the projects, making it difficult to maintain the…

Software Engineering · Computer Science 2025-08-26 Akhila Sri Manasa Venigalla , Sridhar Chimalakonda