• Home
  • Search
  • Automated API Documentation with Tutorials Generated From Stack Overflow
  • Cite Icon12
  • https://doi.org/10.1145/2973839.2973847Copy DOI Icon

Automated API Documentation with Tutorials Generated From Stack Overflow

  • Sep 19, 2016
  • Adriano M Rocha +1 more
Show More
  • Abstract
  • Literature Map
  • References
  • Citations
  • Similar Papers
Abstract

Software reuse provides benefits during the software development and maintenance processes. The use of APIs is one of the most common ways to reuse. However, obtaining an easy-to-understand documentation is a challenge faced by developers. Several papers have proposed alternatives to make API documentation more understandable, or even more detailed. However, these studies have not taken into account the complexity of examples in order to make documentation adaptable to different levels of developer experience. In this work, we developed and evaluated four different methodologies to generate tutorials for APIs from the contents of Stack Overflow and organize them according to the complexity of understanding. The methodologies were evaluated through tutorials generated for the Swing API. A survey was conducted to evaluate eight different features of the generated tutorials. The overall outcome was positive on several characteristics, showing the feasibility of automatically generated tutorials. In addition, the adoption of features for presenting tutorial elements in order of complexity, for separating the tutorial in basic and advanced parts, for selecting posts with a tutorial nature and with didactic source code had significantly better results regarding the generation methodology.

Similar Papers
  • Research Article

The GUMP Process for Software Maintenance and Maintenance Education

  • Jul 01, 1996
  • Journal of Software Maintenance: Research and Practice
  • Norman Wilde +1
  • Research Article
  • Citations1

The GUMP Process for Software Maintenance and Maintenance Education

  • Jul 01, 1996
  • Journal of Software Maintenance: Research and Practice
  • Norman Wilde +1
  • Research Article
  • Citations5

Improving the Governance of Software Maintenance Process for Agile Software Development Team

  • Dec 09, 2018
  • International Journal of Engineering & Technology
  • Salfarina Abdullah +2
  • PDF
  • Research Article
  • Citations148

Software Bug Prediction using Machine Learning Approach

  • Jan 01, 2018
  • International Journal of Advanced Computer Science and Applications
  • Awni Hammouri +3
  • Research Article
  • Citations11

Software metrics: fault content estimation and software process control

  • Sep 01, 1987
  • Microprocessors and Microsystems
  • Bo Lennselius +2
  • Conference Article
  • Citations274

You Get Where You're Looking for: The Impact of Information Sources on Code Security

  • May 01, 2016
  • Yasemin Acar +5
  • Book Chapter

Software Measurement and Service Levels

  • Apr 25, 2012
  • Barbara Beech
  • Book Chapter
  • Citations1

Truly Parallel Model-Matching Algorithm in OpenCL

  • Jan 01, 2017
  • Tamás Fekete +1
  • Research Article
  • Citations1

Python API Misuse Mining and Classification Based on Hybrid Analysis and Attention Mechanism

  • Aug 07, 2023
  • International Journal of Software Engineering and Knowledge Engineering
  • Xincheng He +2
  • Research Article
  • Citations13

Metrics for evaluation of metaprogram complexity

  • Jan 01, 2010
  • Computer Science and Information Systems
  • Robertas Damasevicius +1
  • Research Article
  • Citations23

Uses and applications of Software & Systems Process Engineering Meta‐Model process models. A systematic mapping study

  • Apr 10, 2013
  • Journal of Software: Evolution and Process
  • Iván Ruiz‐Rube +4
  • Research Article
  • Citations17

Development of a Model for Teaching Manipulation of a Distal Radial Fracture

  • Mar 06, 2013
  • Journal of Bone and Joint Surgery
  • Ciara Egan +4
  • Research Article
  • Citations8

Workplace stressor factors, profiles and the relationship to career stage in UK veterinarians, veterinary nurses and students.

  • Jul 01, 2024
  • Veterinary medicine and science
  • Jason Spendelow +6
  • Research Article
  • Citations94

Evaluation of MRI-TRUS fusion versus cognitive registration accuracy for MRI-targeted, TRUS-guided prostate biopsy.

  • Jan 01, 2015
  • American Journal of Roentgenology
  • Derek W Cool +5
  • Conference Article

An intelligent assistant for software information checking using a non-monotonic reasoning system

  • Jan 03, 1989
  • J.J Tsai +1
Cactus Communications logo

Copyright 2026 Cactus Communications. All rights reserved.