Skip to main content

LUP Student Papers

LUND UNIVERSITY LIBRARIES

Optimizing the usability of REST API reference documentation

Holmqvist, Axel LU and Jungermann, David LU (2021) MAMM01 20211
Ergonomics and Aerosol Technology
Abstract
With an increasingly growing demand for accessible data, the amount of REST API:s worldwide is growing. All REST API:s come with some form of reference documentation, which is crucial for the comprehension and usage of the API. Every API provider should therefore consider the usability of their reference documentation, to facilitate the learning and usage of their product.

This master's thesis was performed in collaboration with Homepal AB, a startup company within the real estate industry. The master's thesis explores what features and properties should be included in a reference documentation order to support the needs of the end users. Furthermore, it aims to investigate how different types of developers use reference documentation... (More)
With an increasingly growing demand for accessible data, the amount of REST API:s worldwide is growing. All REST API:s come with some form of reference documentation, which is crucial for the comprehension and usage of the API. Every API provider should therefore consider the usability of their reference documentation, to facilitate the learning and usage of their product.

This master's thesis was performed in collaboration with Homepal AB, a startup company within the real estate industry. The master's thesis explores what features and properties should be included in a reference documentation order to support the needs of the end users. Furthermore, it aims to investigate how different types of developers use reference documentation differently. These learnings were then applied to a prototype, that was subject to evaluation in several stages.

By using a user-centered design process and an iterative approach, with interviews and and a usability study, combined with literature studies of former research, heuristic analyzes of example documentation, along with insights from the private sector, prototypes of different levels were created and iterated with the goal of creating a final prototype illustrating the learnings, that then could be used as inspiration for improving the reference documentation of Homepal.

The result of the design process, and the final prototype, was mainly evaluated through user observation and feedback, as well as the usage of the System Usability Scale. The prototype was highly and widely appreciated among the users, and received an average SUS score of 95. (Less)
Abstract (Swedish)
Med allt större efterfrågan på tillgänglig data ökar antalet REST API:er markant världen över. Varje REST API har någon form av referensdokumentation, vilket är avgörande för förståelsen samt användandet av ett API. Samtliga API-leverantörer bör således överväga optimering av referensdokumentationens användbarhet för att underlätta inlärning och användning av sin produkt.

Denna masteravhandling utfördes i samarbete med Homepal AB, ett startup-företag inom fastighetsbranschen. Mastersavhandlingen ämnar att undersöka vilken funktionalitet och vilka egenskaper som bör inkluderas i en referensdokumentation för att uppfylla slutanvändarnas behov, samt undersöka hur olika typer av utvecklare använder sig utav referensdokumentation på olika... (More)
Med allt större efterfrågan på tillgänglig data ökar antalet REST API:er markant världen över. Varje REST API har någon form av referensdokumentation, vilket är avgörande för förståelsen samt användandet av ett API. Samtliga API-leverantörer bör således överväga optimering av referensdokumentationens användbarhet för att underlätta inlärning och användning av sin produkt.

Denna masteravhandling utfördes i samarbete med Homepal AB, ett startup-företag inom fastighetsbranschen. Mastersavhandlingen ämnar att undersöka vilken funktionalitet och vilka egenskaper som bör inkluderas i en referensdokumentation för att uppfylla slutanvändarnas behov, samt undersöka hur olika typer av utvecklare använder sig utav referensdokumentation på olika tillvägagångssätt. Dessa lärdomar applicerades sedan slutligen på en prototyp som utvärderades i flera steg.

Genom att använda en användarcentrerad designprocess och ett iterativt tillvägagångssätt, med intervjuer och användbarhetsstudier kombinerat med litteraturstudier av tidigare forskning, heuristiska analyser av dokumentationsexempel, samt insikter från den privata sektorn, skapades prototyper på olika nivåer vilka itererades med målet att skapa en slutgiltig prototyp som illustrerar den kunskap som samlats, och som kan fungera som inspiration för att förbättra Homepals referensdokumentation.

Resultatet av designprocessen och prototypen utvärderades huvudsakligen genom användarobservation och feedback, samt genom användning av System Usabilty-skalan. Prototypen uppskattades mycket och brett bland användarna, och fick ett genomsnittlig SUS-resultat på 95. (Less)
Please use this url to cite or link to this publication:
author
Holmqvist, Axel LU and Jungermann, David LU
supervisor
organization
course
MAMM01 20211
year
type
H2 - Master's Degree (Two Years)
subject
keywords
REST API, reference documentation, usability, user centered design, user experience
language
English
id
9057307
date added to LUP
2021-06-22 09:39:13
date last changed
2021-06-22 09:39:13
@misc{9057307,
  abstract     = {{With an increasingly growing demand for accessible data, the amount of REST API:s worldwide is growing. All REST API:s come with some form of reference documentation, which is crucial for the comprehension and usage of the API. Every API provider should therefore consider the usability of their reference documentation, to facilitate the learning and usage of their product.

This master's thesis was performed in collaboration with Homepal AB, a startup company within the real estate industry. The master's thesis explores what features and properties should be included in a reference documentation order to support the needs of the end users. Furthermore, it aims to investigate how different types of developers use reference documentation differently. These learnings were then applied to a prototype, that was subject to evaluation in several stages.

By using a user-centered design process and an iterative approach, with interviews and and a usability study, combined with literature studies of former research, heuristic analyzes of example documentation, along with insights from the private sector, prototypes of different levels were created and iterated with the goal of creating a final prototype illustrating the learnings, that then could be used as inspiration for improving the reference documentation of Homepal.

The result of the design process, and the final prototype, was mainly evaluated through user observation and feedback, as well as the usage of the System Usability Scale. The prototype was highly and widely appreciated among the users, and received an average SUS score of 95.}},
  author       = {{Holmqvist, Axel and Jungermann, David}},
  language     = {{eng}},
  note         = {{Student Paper}},
  title        = {{Optimizing the usability of REST API reference documentation}},
  year         = {{2021}},
}