Kehittäjäkokemuksen toteutuminen teknisessä dokumentaatiossa

Abstract

Ohjelmistokehitys, siinä missä moni muukin ajatustyö, on ihmislähtöistä toimintaa. Vaikka ala on hyvin teknologiaorientoitunut, loppupeleissä työnteosta vastaavat aina ohjelmoijat, ihmiset. Tämän vuoksi ohjelmoijien työskentelytyytyväisyyteen eli kehittäjäkokemukseen on kiinnitettävä erityistä huomiota. Tässä tutkimuksessa tutkittiin toimeksiantajan yhteistyökumppanien suhtautumista sen tekniseen dokumentaatioon kehittäjäkokemuksen näkökulmasta. Kirjallisuuden avulla perehdyttiin lean-ajatteluun ohjelmistokehityksessä, kehittäjäkokemukseen sekä dokumentaatioon. Teorian avulla luotiin kyselylomake ja se lähetettiin toimeksiantajalta saaduille sähköpostiosoitteisiin yhdessä saatekirjeen kanssa. Tarkoituksena oli selvittää, miten kumppanit kokevat dokumentaation palvelevan heitä heidän jokapäiväisessä työssään ja, miten se voisi olla entistä parempi. Tutkimus toteutettiin siis määrällisenä kyselytutkimuksena, mutta avoimien kysymysten vuoksi siinä oli myös laadullisia osa-alueita. Kyselytutkimuksen otanta osoittautui odotettua pienemmäksi, minkä vuoksi tuloksista ei voida yleistää vaan niistä voidaan vetää ainoastaan suuntaa antavia johtopäätöksi toimeksiantajan dokumentaation tiimoilta. Yleisesti ottaen dokumentaatio osoittautui melko hyväksi kumppanien keskuudessa, mutta silti joitain kehitysehdotuksia löytyi. Etenkin dokumentaation sekavuus, keskeneräisyys ja koodiesimerkkien määrä saivat kritiikkiä. Dokumentaation rakenteen selkeyttäminen parantaisi sekavuutta, mikä puolestaan kohentaisi kehittäjäkokemusta. Vastaajat kaipasivat yleisesti lisää koodiesimerkkejä ja mielellään useimmilla eri ohjelmointikielillä. Eniten ääni keräsivät PHP, JavaScript, Python ja Curl.

Software development, like many other forms of thinking-related work, is a people-oriented activity. Although the industry is very technology-oriented, at the end of the day, the work is always done by people. Therefore, particular attention must be paid to the job satisfaction of programmers, i.e., the developer experience. This study investigated the attitude of the client's technical partners. Literature was used to explore lean thinking in software development, developer experience and documentation. A questionnaire was created using the theory and sent to the email addresses provided by the client together with a cover letter. The aim was to find out how the partners perceive the documentation to help them in their daily work and how it could be improved. The survey was therefore conducted as a quantitative survey, but due to the open questions, it also had qualitative elements. The survey sample turned out to be smaller than expected, which means that the results cannot be generalised and can only be used to draw some indicative conclusions about the client's documentation. In general, the documentation proved to be quite good among the partners, but there were still some improvements to be done. In particular, the documentation was criticised for its incoherence, incompleteness, and the amount of code examples. Clarifying the structure of the documentation would improve the confusion, which would improve the developer experience. Respondents generally wanted more code examples, preferably in more programming languages. PHP, JavaScript, Python and Curl received the most amount votes.