论文标题
Zur Benutzbarkeit und verwendung von api-dokumentationen
Zur Benutzbarkeit und Verwendung von API-Dokumentationen
论文作者
论文摘要
良好的文档对于（安全）API的良好可用性至关重要，即特别是对于正确使用API。在几篇论文中已经描述了对API的良好文档的要求，但是没有实现这些要求的技术实施（以下称为文档系统）。要求可以分为文档系统的要求和文档内容的要求。在对文档系统本身的13个确定要求中，有9个是在原型中实现的，并在用户研究中对22位使用加密API进行了评估。事实证明，要求“启用快速使用API”的实现取决于输入内容的质量，但另一方面还包括其他5个其他要求或其实施。测试人员几乎没有使用或根本没有使用的其他两个实施要求（“经典参考”和“问答功能”）。它们的有用性和相关性应在一项长期研究中进行研究。
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.
