Zur Benutzbarkeit und Verwendung von API-Dokumentationen

07/10/2020
by   Rolf Huesmann, et al.
0

A good documentation is essential for a good usability of (security) APIs, i.e. especially for the correct use of the APIs. Requirements for good documentation of APIs have been described in several papers, but there is no technical implementation (hereinafter referred to as a documentation system) that implements these requirements. The requirements can be divided into requirements for the documentation system and requirements for the documentation content. Out of 13 identified requirements for a documentation system itself, 9 were implemented in a prototype and evaluated in a user study with 22 test persons using a cryptographic API. It turned out that the implementation of the requirement 'Enable quick use of the API' depends on the one hand on the quality of the content entered, but on the other hand also includes 5 other requirements or their implementation. The two other implemented requirements ('classic reference' and 'question and answer function') were hardly or not at all used by the test persons. Their usefulness and relevance should be investigated in a long-term study.

READ FULL TEXT

page 5

page 8

research
05/24/2018

Why Johnny Can't Store Passwords Securely? A Usability Evaluation of Bouncycastle Password Hashing

Lack of usability of security Application Programming In- terfaces (APIs...
research
08/17/2018

The Case for API Communicability Evaluation: Introducing API-SI with Examples from Keras

In addition to their vital role in professional software development, Ap...
research
08/09/2023

Is unsafe an Achilles' Heel? A Comprehensive Study of Safety Requirements in Unsafe Rust Programming

Rust is an emerging, strongly-typed programming language focusing on eff...
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
05/05/2021

Don't forget your classics: Systematizing 45 years of Ancestry for Security API Usability Recommendations

Producing secure software is challenging. The poor usability of security...
research
05/06/2023

On the usefulness of linear types for correct nonce use enforcement during compile time

Cryptographic algorithms and protocols often need unique random numbers ...
research
05/23/2023

On the relevance of APIs facing fairwashed audits

Recent legislation required AI platforms to provide APIs for regulators ...

Please sign up or login with your details

Forgot password? Click here to reset