Ohjelmointirajapintojen käyttäjien tietotarpeiden tukeminen dokumentaation avulla

Thumbnail Image

Files

URL

Journal Title

Journal ISSN

Volume Title

Perustieteiden korkeakoulu | Bachelor's thesis
Electronic archive copy is available locally at the Harald Herlin Learning Centre. The staff of Aalto University has access to the electronic bachelor's theses by logging into Aaltodoc with their personal Aalto user ID. Read more about the availability of the bachelor's theses.
Unless otherwise stated, all rights belong to the author. You may download, display and print this publication for Your own personal use. Commercial use is prohibited.

Authors

Date

2024-12-12

Department

Major/Subject

Tietotekniikka

Mcode

SCI3027

Degree programme

Teknistieteellinen kandidaattiohjelma

Language

fi

Pages

20

Series

Abstract

Ohjelmointirajapinnat (engl. Application Programming Interface, API) sekä niiden rajapintadokumentaatio ovat keskeinen osa modernia ohjelmistokehitykstä. Tämä kandidaatintyö kartoittaa ohjelmoijien tietotarpeita heidän opetellessaan käyttämään uusia rajapintoja sekä tapoja tukea ohjelmoijia rajapintadokumentaation avulla. Ensin käsitellään ohjelmoijien tietotarpeita heidän käyttäessään uusia rajapintoja. Rajapintoja opetellessa ohjelmoijilla on kärjistetysti kaksi tavoitetta: selvittää, onko rajapinnalla mahdollista ratkaista jokin ongelma sekä oppia käyttämään rajapintaa ongelman ratkaistakseen. Ensiksi uuteen rajapintaan tutustuessa ohjelmoijat pyrkivät saamaan rajapinnan tarkoituksesta ja toiminnoista korkeamman tason käsityksen. Korkeamman tason käsityksen saatuaan ohjemoijat jakautuvat karkeasti kahteen ryhmään oppimisstrategian mukaan: toiset ohjelmoijat ovat koodiorientoituneempia ja pyrkivät rajapinnan nopeaan käyttöönottoon sekä ongelmansa ratkaisuun, ja toiset ovat käsiteorientoituneempia ja pyrkivät oppimaan rajapintaa syvemmin ja järjestelmällisemmin. Lopuksi perehdytään rajapintadokumentaation rakenteeseen ja sisältöön. Rakenteen puolesta ohjelmoijille erityisen tärkeää on selkeää jäsentely ja tiedon löydettävyys. Toisteisuutta ja itsestäänselvää tietoa kannattaa välttää, ja hajauttamisen sijaan kannattaa suosia tiedon paikallisuutta. Sisällön suhteen tärkeää on huomioida dokumentaation ajantasaisuus, valmius ja kattavuus. Dokumentaation on hyvä tukea nopean yleiskatsauksen saamista, ja sisällössä kannattaa huomioida oikeantasoinen läpäisevyys eli analysoinnin ja ymmärtämisen tukeminen ilman liikainformaatiota. Rajapinnan suunnitteluun liittyviä tarkoituksia ja päätöksiä voi dokumentoida tarvittaessa. Erityisen tärkeä osa rajapintadokumentaation sisältöä ovat informaatiopitoiset koodiesimerkit, jotka toimivat ohjelmoijille ensikosketuksena rajapintaan ja opettavat sen oikeaoppista käyttöä. Koodiesimerkkien laatu ja oikeantasoinen opettavuus on tärkeä varmistaa.

Description

Supervisor

Savioja, Lauri

Thesis advisor

Heinonen, Ava

Keywords

ohjelmointirajapinnat, API, tietotarpeet, rajapintadokumentaatio

Other note

Citation

Permanent link to this item

https://urn.fi/URN:NBN:fi:aalto-202412177833

Collections

[kand] Perustieteiden korkeakoulu / SCI