Return to search

The ‘boring’ but important part of our work : A Case Study on Developer Experience Enhancements for Technical Documentation

IST is a company that develops software for the education sector. The company's growth has led to inconsistency in its software suite, negatively impacting user and developer experience. User interface components such as buttons and forms vary in design and implementation across their services, making it challenging for users to navigate and for developers to maintain. To improve this, IST has started a project to switch to a different front-end architecture, known as micro-frontend, which will need to be accompanied by technical documentation. This project is referred to as ‘CommonUI’. Reading and contributing to documentation, especially for software, is indicated by existing literature to be perceived unappealing by developers. This thesis aims to explore developers' attitudes toward documentation and proposes Developer Experience-oriented features. The method process involves a literature review, semi-structured interviews and identifying themes using thematic analysis. The findings reject the hypothesis that developers find documentation unappealing, indicating that most developers view engaging with documentation positively, motivated by altruism. Key themes identified from the interviews include the need for examples, up-to-date, concise text, and easily findable documentation. Proposed features to improve the Developer Experience include interactive component examples, integration of documentation with design specifications, dynamic presentation of code from source files, mechanisms for user feedback, text limitations, and enhanced search functionality.

Identiferoai:union.ndltd.org:UPSALLA1/oai:DiVA.org:lnu-130119
Date January 2024
CreatorsRasmussen, Hannes
PublisherLinnéuniversitetet, Institutionen för datavetenskap och medieteknik (DM)
Source SetsDiVA Archive at Upsalla University
LanguageEnglish
Detected LanguageEnglish
TypeStudent thesis, info:eu-repo/semantics/bachelorThesis, text
Formatapplication/pdf
Rightsinfo:eu-repo/semantics/openAccess

Page generated in 0.0021 seconds