How API Documentation Fails

No abstract is available for this paper.

• Publication year

  2015

• Venue

  IEEE Software

• Publication date

  2015-06-30

• Fields of study

  Computer Science

• Identifiers
  DOI 10.1109/MS.2014.80
• External record

  Open on Semantic Scholar

• Source metadata

  Semantic Scholar

• No claims are published for this paper.

• No concepts are published for this paper.

• Assessing the value of branches with what-if analysis

  2012cited by this paper
• What makes a good code example?: A study of programming Q&A in StackOverflow

  2012cited by this paper
• A field study of API learning obstacles

  2011cited by this paper
• Creating and evolving developer documentation: understanding the decisions of open source contributors

  2010cited by this paper
• How software engineers use documentation: the state of the practice

  2003cited by this paper
• PHD STUDENT

  year unknowncited by this paper

• From Docs to Descriptions: Smell-Aware Evaluation of MCP Server Descriptions

  2026cites this paper
• Automating API Documentation from Crowdsourced Knowledge

  2026cites this paper
• ContextCov: Deriving and Enforcing Executable Constraints from Agent Instruction Files

  2026cites this paper
• Does My README File Need To Be Updated? Exploring LLM-Based README Maintenance

  2026cites this paper
• It Should Be Easy but... New Users' Experiences and Challenges with Secret Management Tools

  2025cites this paper
• DocPrism: Local Categorization and External Filtering to Identify Relevant Code-Documentation Inconsistencies

  2025cites this paper
• APIDocBooster: An Extract-Then-Abstract Framework for Augmenting API Documentation

  2025cites this paper
• Automated and Context-Aware Code Documentation Leveraging Advanced LLMs

  2025cites this paper
• Intelligent Code Completion by a Unified Multi-task Learning with a Large Language Model

  2025cites this paper
• Extended Version: It Should Be Easy but... New Users Experiences and Challenges with Secret Management Tools

  2025cites this paper
• TestLoop: A Process Model Describing Human-in-the-Loop Software Test Suite Generation

  2025cites this paper
• Model Cards Revisited: Bridging the Gap Between Theory and Practice for Ethical AI Requirements

  2025cites this paper
• Into the ML-Universe: An improved classification and characterization of machine-learning projects

  2025cites this paper
• Evaluating the Use of LLMs for Documentation to Code Traceability

  2025influential citation
• Evaluating Prompt-Learning-Based API Review Classification Through Pre-Trained Models

  2025cites this paper
• Identifying Multi-parameter Constraint Errors in Python Data Science Library API Documentation

  2025cites this paper
• One Documentation Does Not Fit All : Case study of TensorFlow Documentation

  2025cites this paper
• Improving API Knowledge Comprehensibility: A Context-Dependent Entity Detection and Context Completion Approach Using LLM

  2025cites this paper
• An explanation of software architecture explanations

  2025cites this paper
• Characterising harmful API uses and repair techniques: Insights from a systematic review

  2025cites this paper
• Leave it to the parents: How hacktivism-as-tuning reconfigures public sector digital transformation

  2025cites this paper
• Adapting Installation Instructions in Rapidly Evolving Software Ecosystems

  2025influential citation
• API Guardian: An Educational and Experimental Tool for Learning and Teaching the Verification and Validation of RESTful API Endpoints

  2025cites this paper
• Detecting and Mitigating Inconsistencies Between Code, Documentation and Tests

  2025cites this paper
• Why People Contribute Software Documentation

  2024cites this paper
• Detecting Multi-Parameter Constraint Inconsistencies in Python Data Science Libraries

  2024cites this paper
• Enhancing API Labelling with BERT and GPT: An Exploratory Study

  2024cites this paper
• Software Systems Documentation: A Systematic Review

  2024cites this paper
• Reputation Gaming in Crowd Technical Knowledge Sharing

  2024cites this paper
• Code Compass: A Study on the Challenges of Navigating Unfamiliar Codebases

  2024cites this paper
• Ivie: Lightweight Anchored Explanations of Just-Generated Code

  2024cites this paper
• The Paradox of Function Header Comments

  2024cites this paper
• Rest API based Web Interface for Blogging Application

  2023cites this paper
• Non-Linear Software Documentation with Interactive Code Examples

  2023cites this paper
• APIDocBooster: An Extract-Then-Abstract Framework Leveraging Large Language Models for Augmenting API Documentation

  2023cites this paper
• Support for Long-Form Documentation Authoring and Maintenance

  2023cites this paper
• Understanding Documentation Use Through Log Analysis: An Exploratory Case Study of Four Cloud Services

  2023cites this paper
• DSDGen: Extracting Documentation to Comprehend Fork Merges

  2023cites this paper
• Using an LLM to Help with Code Understanding

  2023cites this paper
• Towards a taxonomy of Roxygen documentation in R packages

  2023cites this paper
• Evaluating Software Documentation Quality

  2023influential citation
• RECOMMENDING JAVA API METHODS BASED ON PROGRAMMING TASK DESCRIPTIONS BY NOVICE PROGRAMMERS

  2023influential citation
• ecode: An R package to investigate community dynamics in ordinary differential equation systems

  2023cites this paper
• Documenting Software Architecture Design in Compliance with the ISO 26262: a Practical Experience in Industry

  2023cites this paper
• Combining Contexts from Multiple Sources for Documentation-Specific Code Example Generation

  2023cites this paper
• An Empirical Study of Web Services Topics in Web Developer Discussions on Stack Overflow

  2023cites this paper
• Understanding Roxygen package documentation in R

  2022cites this paper
• Aspect-Based API Review Classification: How Far Can Pre-Trained Transformer Model Go?

  2022cites this paper
• Synthesising Linear API Usage Examples for API Documentation

  2022cites this paper
• An Insight into the Reusability of Stack Overflow Code Fragments in Mobile Applications

  2022cites this paper
• Detecting outdated code element references in software repository documentation

  2022cites this paper
• Understanding Inconsistency in Azure Cosmos DB with TLA+

  2022cites this paper
• Identifying Solidity Smart Contract API Documentation Errors

  2022influential citation
• Automatic prediction of rejected edits in Stack Overflow

  2022cites this paper
• Assessing the Impact of Code Samples Evolution on Developers’ Questions

  2022cites this paper
• Assessing Real-World Applicability of Redesigned Developer Documentation for Certificate Validation Errors

  2022influential citation
• Does Collaborative Editing Help Mitigate Security Vulnerabilities in Crowd-Shared IoT Code Examples?

  2022cites this paper
• Automatic Code Documentation Generation Using GPT-3

  2022cites this paper
• Developer discussion topics on the adoption and barriers of low code software development platforms

  2022cites this paper
• Suboptimal Comments in Java Projects: From Independent Comment Changes to Commenting Practices

  2022cites this paper
• ARSeek: Identifying API Resource using Code and Discussion on Stack Overflow

  2022cites this paper
• Topology of the Documentation Landscape

  2022cites this paper
• Casdoc: Unobtrusive Explanations in Code Examples

  2022cites this paper
• Improving open data web API documentation through interactivity and natural language generation

  2022cites this paper
• Practitioners' Expectations on Automated Code Comment Generation

  2022influential citation
• “I just looked for the solution!”On Integrating Security-Relevant Information in Non-Security API Documentation to Support Secure Coding Practices

  2022cites this paper
• Challenges of API Documentation from a Provider Perspective and Best Practices for Examples in Public Web API Documentation

  2022cites this paper
• Automatic Detection and Analysis of Technical Debts in Peer-Review Documentation of R Packages

  2022cites this paper
• Aspirations and Practice of ML Model Documentation: Moving the Needle with Nudging and Traceability

  2022cites this paper
• A qualitative study of developers’ discussions of their problems and joys during the early COVID-19 months

  2022cites this paper
• Rollback Edit Inconsistencies in Developer Forum

  2021cites this paper
• Enriching API Documentation with Code Samples and Usage Scenarios from Crowd Knowledge

  2021cites this paper
• Identifying change patterns of API misuses from code changes

  2021cites this paper
• Recommending API Function Calls and Code Snippets to Support Software Development

  2021cites this paper
• SOAR: A Synthesis Approach for Data Science API Refactoring

  2021cites this paper
• Automatic Detection of Five API Documentation Smells: Practitioners’ Perspectives

  2021cites this paper
• Automatic API Usage Scenario Documentation from Technical Q&A Sites

  2021influential citation
• Understanding Emotions of Developer Community Towards Software Documentation

  2021cites this paper
• On Indirectly Dependent Documentation in the Context of Code Evolution: A Study

  2021cites this paper
• A Theory of Robust API Knowledge

  2021cites this paper
• Exploring User Experience of Automatic Documentation Tools

  2021cites this paper
• A Systematic Review of API Evolution Literature

  2021cites this paper
• A Survey-Based Qualitative Study to Characterize Expectations of Software Developers from Five Stakeholders

  2021cites this paper
• Dialogue Management for Interactive API Search

  2021cites this paper
• Turnover-induced knowledge loss in practice

  2021cites this paper
• An Empirical Comparison Between Tutorials and Crowd Documentation of Application Programming Interface

  2021cites this paper
• An empirical study of IoT topics in IoT developer discussions on Stack Overflow

  2021cites this paper
• Scout-bot: Leveraging API Community Knowledge for Exploration and Discovery of API Learning Resources

  2021influential citation
• FACOS: Finding API Relevant Contents on Stack Overflow with Semantic and Syntactic Analysis

  2021cites this paper
• Understanding How Programmers Can Use Annotations on Documentation

  2021influential citation
• A Mixed-Method Approach to Recommend Corrections and Correct REST Antipatterns

  2021cites this paper
• Leveraging Unsupervised Learning to Summarize APIs Discussed in Stack Overflow

  2021cites this paper
• Mining API Constraints from Library and Client to Detect API Misuses

  2021cites this paper
• Reputation Gaming in Stack Overflow

  2021cites this paper
• Interactive Program Distillation

  2020cites this paper
• Interpreting Cloud Computer Vision Pain-Points: A Mining Study of Stack Overflow

  2020cites this paper
• Mining API usage scenarios from stack overflow

  2020cites this paper
• A Review of Pattern Languages for Software Documentation

  2020cites this paper
• Service API Modeling and Comparison: A Technology-Independent Approach

  2020cites this paper
• Augmenting Software Documentation through Crowd-sourcing Annotations with ADAMITE

  2020influential citation