Computer Science
3 years ago

Revolutionizing API Documentation: Basic Elements for User-Friendly Functionality Access

Advances in intelligent systems and computing
API Documentation
Sergio Inzunza, Reyes Juárez‐Ramírez, Samantha Jiménez

Paper Summary

Related papers

Theme background image
Computer Science
3 years ago

Revolutionizing API Documentation: Basic Elements for User-Friendly Functionality Access

Empirical Studies
Open Source Innovation
Data Extraction
1 view
Business, Management and Accounting
8 years ago

Unlocking the Power of Technical Documentation Across Industries and Business Environments

Management Education
1 view
Theme background image
Computer Science
5 years ago

Neglected Software Documentation Leads to Unfavorable User Experiences.

Empirical Studies
Open Source Innovation
Autonomic Computing
1 view

API documentation is crucial for developers to understand how to use the functionality of an API. However, many current documentation lacks important information. A study identified basic elements that all API documentation should include to help users learn and utilize the API effectively. By surveying software developers, the study determined the importance of these elements. A new method was proposed to evaluate API documentation quality, which was tested on popular online API documentation across different domains.