dokumentaatiotavat
Dokumentaatiotavat ovat erilaisia keinoja ja formaatteja, joiden avulla tieto tallennetaan, esitetään ja säilytetään. Niiden tarkoituksena on tukea ymmärrystä, käyttöä sekä ylläpitoa eri konteksteissa, kuten ohjelmistokehityksessä, tutkimuksessa, tuotannossa ja koulutuksessa. Dokumentaatiotavat löytyy sekä yksittäisten dokumenttien että koko dokumentaatiokokonaisuuden tasolta.
Tärkeimmät dokumentaatiotavat voidaan jakaa seuraaviin kategorioihin:
- Tekstuaalinen dokumentaatio: käyttöohjeet, tekniset spesifikaatiot, projektiraportit, muistiinpanot ja muut kirjoitetut ohjeet.
- Visuaalinen dokumentaatio: kaaviot, vuokaaviot, arkkitehtuurikartat, UML-diagrammit, käyttöliittymämockupit sekä kartat tai kuvat.
- Multimedialinen dokumentaatio: videot, äänitteet ja screencastit, jotka havainnollistavat toimintoja ja prosesseja.
- Rakenteellinen data: metatiedot, sanastot, tietokanta- ja tiedostoformaatteja kuvaavat skeemat (esim. XML, JSON) sekä tietomallit.
- Ylläpito- ja käyttöönotto: asennus- ja konfiguraatio-ohjeet, päivitysohjeet sekä versiointi.
- Saavutettavuus ja kansainvälistäminen: tekstit vaihtoehdoilla, saavutettavuusstandardit (esim. WCAG) sekä lokalisaatio- ja käännöstyö.
Dokumentaatiotapojen valinta riippuu kohderyhmästä, käyttötarkoituksesta, saatavilla olevista resursseista sekä sovellusalasta. Hyötyjä ovat parempi ymmärrys, helpompi ylläpito,