An application programming interface (API) allows different software applications to communicate and interact with each other. The API is accompanied by documentation, which contains information about what the API does and how to use it. For an API to be useful and attractive to developers, it is important that the documentation is comprehensive, organised and accessible. If not, the API runs the risk of being abandoned. Research has shown that good API documentation facilitates good API usability, therefore, the design and content of the documentation should not be dismissed.

This study takes a user-centred approach to investigate the user experience of API documentation among developers. Nine developers participated in the study. By exploring how software developers use documentation, it aims to identify key areas for improvement and develop strategies to improve the overall usability of documentation. Important elements that enhance user experience are highlighted. These elements included, among others, a search function, version manager, and a display of resource status. This research provides insights into the design of software documentation and how to design with a user-centred approach. This approach shows how user-centred design methods can be very useful in discovering user requirements and meeting user needs in product development processes.

Ett applikationsprogrammeringsgränssnitt (API) gör det möjligt för olika mjukvaruapplikationer att kommunicera och interagera med varandra. Med API:et medföljer dokumentation som innehåller information om vad API:et gör och hur det används. För att ett API ska vara användbart och attraktivt för utvecklare är det viktigt att dokumentationen är omfattande, organiserad och enkel att använda, annars riskerar API:et att överges. Forskning har visat att bra API-dokumentation ökar API:ets användbarhet och därför bör man inte bortse från dokumentationens design och innehåll.

Denna studie använder en användarcentrerad metod för att undersöka utvecklares användarupplevelse av API-dokumentation. Nio utvecklare deltog i studien. Genom att undersöka hur utvecklare använder dokumentation syftar studien på att identifiera förbättringsområden och utveckla strategier för att förbättra användbarheten. Specifika element som bidrar till en förbättrad användarupplevelse betonas. Dessa element inkluderade bland annat en sökfunktion, versionshanterare och en visning av resursstatus. Denna forskning ger insikter i designen av mjukvarudokumentation och hur man utformar den genom ett användarcentrerat tillvägagångssätt. Studien visar hur användarcentrerade designmetoder kan vara mycket användbara för att upptäcka användarkrav och tillgodose användarnas behov i produktutvecklingsprocesser.