Ohjelmiston dokumentaation tyypit

Sisällysluettelo:

Anonim

Jos olet koskaan nähnyt yrityksesi verkkoasemassa olevan tietokoneen hakemiston nimeltä "ohjelmistoasiakirjat" tai "ohjelmisto-oppaat", ja katsoi sitten asiakirjoja, joilla oli lupa tarkastella, olet todennäköisesti ymmärtänyt ohjelmistojen asiakirjojen määrän ja asiakirjojen tyypit. lukuisia. Näyttäisi myös siltä, ​​että jotkin yhteen ryhmään kuuluvat asiakirjat koskevat myös muita luokkia. Ohjelmistoasiakirjoja käytetään tyypillisen ohjelmiston elinkaaren kaikissa vaiheissa, joten se on hyvä paikka tutkia luotujen asiakirjojen tyyppiä.

Ehdotus

Ohjelmistosovelluksessa määritellään ohjelmistojärjestelmän vaatimukset ja määritellään ohjelmiston tarkoitus ja sen ratkaisemat ongelmat. Siinä määritellään myös ohjelmistohankkeen arvioitu aika ja muut ehdotukseen vaikuttavat tekijät.

Toteutettavuustutkimus

Toteutettavuustutkimus tapahtuu yleensä hankkeen alussa. Tässä vaiheessa määritetään, täyttääkö ohjelmistotehdas asiakkaan liiketoiminnan tarpeet. Toteutettavuustutkimuksen tulos päättää, meneeko hanke vai ei.

Vaatimusten analysointi

Vaatimusten analysointi tarjoaa keinon muuntaa liiketoimintavaatimukset automatisoiduiksi ohjelmistoratkaisuiksi. Ulkoinen konsultti tai yrityksen johto suorittaa yleensä tämän tehtävän. Vaatimukset muuttavat liiketoimintavaatimukset laitteiston, ohjelmiston ja komponenttien todellisiksi eritelmiksi.

Suunnitteluasiakirjat

Suunnitteluasiakirjat tarjoavat perustan ohjelmistokehitykselle teknisesti. Kuten nimestä voi päätellä, tietokantoihin, rajapintoihin, tietoliikenteeseen, web-kehitykseen ja muihin ohjelmiston muihin osa-alueisiin suunnitellaan useita graafisia ja tekstimuotoja ennen koodauksen alkamista.

Koodausasiakirjat

Koodausasiakirjat viittaavat ohjelmiston ohjelmoinnissa käytettyyn lähdekoodiin. Koodi voidaan kirjoittaa millä tahansa käytettävissä olevilla tietokonekielillä, mukaan lukien Java, C ++, PHP ja satoja muita tietokoneen kieliä käytetystä järjestelmästä riippuen.

Testausasiakirjat

Testausryhmät ja kehittäjät luovat testausasiakirjoja ohjelmiston elinkaaren eri vaiheissa. Kehittäjät luovat yksikkötestausasiakirjoja omaan koodiinsa. Testausryhmä tai muut henkilöt, jotka eivät suoraan liity koodiin, suorittavat integrointitestauksen ja liiketoiminnan vaatimusten testauksen.

Käyttöoppaat ja markkinointi

Käyttöoppaat antavat ohjeita siitä, miten uusi ohjelmisto toimii. Jos järjestelmä on suuri ja monimutkainen, käyttöoppaita tuetaan yleensä virallisilla henkilöstökoulutuksilla. Markkinointiasiakirjat kuvaavat uuden ohjelmistojärjestelmän etuja mahdollisille asiakkaille.

Ohjelmistolisenssit

Ohjelmistolisenssien myöntäminen tekee ohjelmistosta laillisen loppukäyttäjän kannalta. Käyttäjät käyttävät ohjelmistoa tekijänoikeusyrityksen antaman ohjelmistolisenssin ehtojen mukaisesti. Kaikilla ohjelmilla ei ole tiukkoja lupaehtoja, ja tämä pätee erityisesti avoimen lähdekoodin tapauksessa. Yleensä ohjelmistojärjestelmissä on jonkinlainen lisensointiasiakirja, jossa määritellään, miten ja missä ohjelmistoa voidaan käyttää.

Suositeltava