Enhancing API Documentation through BERTopic Modeling and Summarization

08/17/2023
by   AmirHossein Naghshzan, et al.
0

As the amount of textual data in various fields, including software development, continues to grow, there is a pressing demand for efficient and effective extraction and presentation of meaningful insights. This paper presents a unique approach to address this need, focusing on the complexities of interpreting Application Programming Interface (API) documentation. While official API documentation serves as a primary source of information for developers, it can often be extensive and lacks user-friendliness. In light of this, developers frequently resort to unofficial sources like Stack Overflow and GitHub. Our novel approach employs the strengths of BERTopic for topic modeling and Natural Language Processing (NLP) to automatically generate summaries of API documentation, thereby creating a more efficient method for developers to extract the information they need. The produced summaries and topics are evaluated based on their performance, coherence, and interoperability. The findings of this research contribute to the field of API documentation analysis by providing insights into recurring topics, identifying common issues, and generating potential solutions. By improving the accessibility and efficiency of API documentation comprehension, our work aims to enhance the software development process and empower developers with practical tools for navigating complex APIs.

READ FULL TEXT
research
08/12/2022

Towards Code Summarization of APIs Using NLP Techniques

Each programming language comes with official documentation to guide dev...
research
04/05/2023

APIHarvest: Harvesting API Information from Various Online Sources

Using APIs to develop software applications is the norm. APIs help devel...
research
03/21/2019

Bootstrapping Cookbooks for APIs from Crowd Knowledge on Stack Overflow

Well established libraries typically have API documentation. However, th...
research
11/27/2021

Leveraging Unsupervised Learning to Summarize APIs Discussed in Stack Overflow

Automated source code summarization is a task that generates summarized ...
research
04/15/2019

Modeling Hierarchical Usage Context for Software Exceptions based on Interaction Data

Traces of user interactions with a software system, captured in producti...
research
12/14/2022

API-Spector: an API-to-API Specification Recommendation Engine

When designing a new API for a large project, developers need to make sm...
research
07/27/2017

Find, Understand, and Extend Development Screencasts on YouTube

A software development screencast is a video that captures the screen of...

Please sign up or login with your details

Forgot password? Click here to reset