English
Related papers

Related papers: What should I document? A preliminary systematic m…

200 papers

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

The rapid proliferation of benchmarks has created significant challenges in reproducibility, transparency, and informed decision-making. However, unlike datasets and models -- which benefit from structured documentation frameworks like…

Machine Learning · Computer Science 2025-12-04 Florian Bordes , Candace Ross , Justine T Kao , Evangelia Spiliopoulou , Adina Williams

Good software documentation encourages good software engineering, but the meaning of "good" documentation is vaguely defined in the software engineering literature. To clarify this ambiguity, we draw on work from the data and information…

Software Engineering · Computer Science 2020-09-09 Christoph Treude , Justin Middleton , Thushari Atapattu

This study tackles the challenges associated with interpreting Application Programming Interface (API) documentation, an integral aspect of software development. Official API documentation, while essential, can be lengthy and challenging to…

Software Engineering · Computer Science 2024-01-23 AmirHossein Naghshzan , Sylvie Ratte

In reaction to growing concerns about the potential harms of artificial intelligence (AI), societies have begun to demand more transparency about how AI models and systems are created and used. To address these concerns, several efforts…

Computers and Society · Computer Science 2024-03-13 David Piorkowski , John Richards , Michael Hind

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

With the expansion of scientific research, the number of scientific research is increasing. A new urgent problem is raised that how to keep these researches in a proper way. Therefore, knowledge mapping methods come into being, providing a…

Digital Libraries · Computer Science 2022-02-22 Fan Shen

Several important aspects of software product quality can be evaluated using dynamic metrics that effectively capture and reflect the software's true runtime behavior. While the extent of research in this field is still relatively limited,…

Software Engineering · Computer Science 2021-01-12 Amjed Tahir , Stephen G. MacDonell

The relevance of code comprehension in a developer's daily work was recognized more than 40 years ago. Consequently, many experiments were conducted to find out how developers could be supported during code comprehension and which code…

Software Engineering · Computer Science 2024-06-27 Marvin Wyrich , Justus Bogner , Stefan Wagner

Almost no modern software system is written from scratch, and developers are required to effectively learn to use third-party libraries or software services. Thus, many practitioners and researchers have looked for ways to create effective…

Software Engineering · Computer Science 2024-03-04 Daye Nam , Andrew Macvean , Brad Myers , Bogdan Vasilescu

API documentation is crucial for developers to learn and use APIs. However, it is known that many official API documents are obsolete and incomplete. To address this challenge, we propose a new approach called AutoDoc that generates API…

Software Engineering · Computer Science 2026-01-14 Bonan Kou , Zijie Zhou , Muhao Chen , Tianyi Zhang

Documentation is an important mechanism for disseminating software architecture knowledge. Software project teams can employ vastly different formats for documenting software architecture, from unstructured narratives to standardized…

Software Engineering · Computer Science 2023-05-30 Neil A. Ernst , Martin P. Robillard

While functionality and correctness of code has traditionally been the main focus of computing educators, quality aspects of code are getting increasingly more attention. High-quality code contributes to the maintainability of software…

Software Engineering · Computer Science 2023-04-27 Hieke Keuning , Johan Jeuring , Bastiaan Heeren

We aim to conduct a systematic mapping in the area of testing ML programs. We identify, analyze and classify the existing literature to provide an overview of the area. We followed well-established guidelines of systematic mapping to…

Machine Learning · Computer Science 2019-07-23 Salman Sherin , Muhammad Uzair khan , Muhammad Zohaib Iqbal

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

Automatic documentation generation tools, or auto docs, are widely used to visualize information about APIs. However, each auto doc tool comes with its own unique representation of API information. In this paper, I use an information…

Software Engineering · Computer Science 2020-11-12 Will Crichton

As research and industry moves towards large-scale models capable of numerous downstream tasks, the complexity of understanding multi-modal datasets that give nuance to models rapidly increases. A clear and thorough understanding of a…

Human-Computer Interaction · Computer Science 2022-04-05 Mahima Pushkarna , Andrew Zaldivar , Oddur Kjartansson

Artificial Intelligence (AI) faces persistent challenges in terms of transparency and accountability, which requires rigorous documentation. Through a literature review on documentation practices, we provide an overview of prevailing…

Digital Libraries · Computer Science 2024-06-28 Stefan Arnold , Dilara Yesilbas , Rene Gröbner , Dominik Riedelbauch , Maik Horn , Sven Weinzierl

Software documentation is an essential but labor intensive task that often requires a dedicated team of developers to ensure coverage and accuracy. Good documentation will help shorten the development cycle and improve the overall team…

Software Engineering · Computer Science 2017-01-31 Thomas Zheng , Jeff Shaw , Sergey Kozlov

With the advent and proliferation of online developer forums as informal documentation, developers often share their opinions about the APIs they use. Thus, opinions of others often shape the developer's perception and decisions related to…

Software Engineering · Computer Science 2021-02-18 Gias Uddin , Olga Baysal , Latifa Guerrouj , Foutse Khomh