Järjestelmäasiakirjat koostuvat kirjallisesta materiaalista, jota käytetään kuvaamaan tietokoneen laitteiston tai ohjelmiston sovelluksia. Asiakirjat voidaan näyttää tulostetuina käsikirjoina, flash-kortteina, Web-sivuina tai näytön ohjetekstinä. Järjestelmäasiakirjat ovat keskeinen osa minkä tahansa tietokonejärjestelmän menestystä. Monilla kehittäjillä on kuitenkin vaikea aika luoda riittävästi dokumentaatiota tuotteistaan. Eri tyyppisillä dokumenteilla on erilaiset tavoitteet, joten asiakirjojen sisältö riippuu sen kohdeyleisöstä.
Hankkeen dokumentaatio
Hankkeen dokumentoinnin tarkoitus kuvaa koko hanketta. Hankkeen dokumentaatio antaa johtajille, esimiehille ja työntekijöille laajan kuvan hankkeen ehdotetuista menetelmistä, resursseista ja tavoitteista. Hanke-ehdotusasiakirjat osoittavat johtajille hankkeen tavoitteet ja budjetin. Tekniset eritelmät kuvaavat hankkeiden laitteisto- ja ohjelmistovaatimuksia. Hankesuunnitelmassa kuvataan ohjelmoijien, teknikoiden ja suunnittelijoiden toimet hankkeen tavoitteiden saavuttamiseksi.
Testiasiakirjat
Testiasiakirjat kuvaavat suunnitelmia tuotteen testaamiseksi ennen sen vapauttamista. Laadunvarmistusosasto kehittää testaussuunnitelmia sekä sisäisille "alfa" -käyttäjille että ulkoisille "beeta" -testaajille.Testausasiakirjat sisältävät testausohjeita - kuten tiettyjä vaiheita testaajien on noudatettava - sen määrittämiseksi, toimiiko tuote suunnitellusti. QA: n työntekijät keräävät myös testauspäiväkirjoja, vikaluetteloita ja raportteja.
Team Documentation
Tiimien jäsenten välinen ajatustenvaihto on elintärkeää hankkeen onnistumiselle. Tiimi-asiakirjat tallentavat nämä vaihtoehdot käytettäviksi nykyisessä projektissa ja tulevissa projekteissa. Ryhmäsuunnitelmat, aikataulut ja tilapäivitykset ovat tärkeimpiä komponentteja tiimin dokumentaatiossa. Tarkistuslistat auttavat projektipäälliköitä tarkastelemaan, mitkä tehtävät joukkue on suorittanut. Ryhmäkokousten pöytäkirjat antavat esimiehille mahdollisuuden seurata erilaisia kysymyksiä, ehdotuksia ja tehtäviä tiimin jäsenten keskuudessa.
Käyttäjän dokumentaatio
Järjestelmän dokumentoinnin kriittisin elementti on sisältö, joka saavuttaa asiakkaan. Käyttäjäasiakirjoissa ei saa olla liian teknistä ammattikieltä, ja siinä on oltava selkeä, tiivis kieli. Käyttöohje on tyypillisesti käyttäjädokumentaation pääkomponentti, mutta käyttäjät luottavat myös muihin lähteisiin. Koulutusresurssit - käsikirjat ja videot mukaan lukien - voivat auttaa käyttäjiä ymmärtämään nopeasti ja helposti, miten järjestelmä toimii. Kun järjestelmä ei toimi odotetulla tavalla, vianmääritysopas voi auttaa käyttäjää löytämään ja ratkaisemaan ongelman.
