Documentation Generation as Information Visualization

11/11/2020
by   Will Crichton, et al.
0

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 visualization analysis of auto docs to generate potential design principles for improving their usability. Developers use auto docs as a reference by looking up relevant API primitives given partial information, or leads, about its name, type, or behavior. I discuss how auto docs can better support searching and scanning on these leads, e.g. by providing more information-dense visualizations of method signatures.

READ FULL TEXT
research
03/06/2023

LIDA: A Tool for Automatic Generation of Grammar-Agnostic Visualizations and Infographics using Large Language Models

Systems that support users in the automatic creation of visualizations m...
research
02/16/2022

Code Generation for Unknown Libraries via Reading API Documentations

Open-domain code generation is a challenging problem because the set of ...
research
03/29/2022

Improving the Learnability of Machine Learning APIs by Semi-Automated API Wrapping

A major hurdle for students and professional software developers who wan...
research
11/14/2021

FACOS: Finding API Relevant Contents on Stack Overflow with Semantic and Syntactic Analysis

Collecting API examples, usages, and mentions relevant to a specific API...
research
02/14/2020

Generating a Generic Fluent API in Java

Context: The algorithms for generating a safe fluent API are actively st...
research
05/08/2019

Pilot evaluation of Collection API with PID Kernel Information

Persistent Identifier (PID) is a widely used long-term unique reference ...
research
08/09/2023

Understanding Auto-Scheduling Optimizations for Model Deployment via Visualizations

After completing the design and training phases, deploying a deep learni...

Please sign up or login with your details

Forgot password? Click here to reset