0. Pikaohje
Enintään yhdellä a4-sivulla kaikkein oleellisimmat asiat.
Sisällys
1. Johdanto
1.1 Ohjelman tarkoitus
Lyhyt yleiskuvaus ohjelmasta: mitä se tekee, mihin se on tarkoitettu.
1.2 Käyttöympäristö
Laitteistovaatimukset (tehokkuus, levytila, näytön minimiresoluutio yms.), ohjelmistovaatimukset (Java- virtuaalikone, selainversio, mahdolliset muut tarvittavat ohjelmat jne.)
1.3 Käytetyt merkinnät
Käyttöohjeessa käytetyt lyhenteet, atk-termit yms.
1.4 Käsitteitä
Määritellään kohdealueen oleelliset käsitteet siltä osin, kun ne eivät ole itsestään selviä.
2. Käyttöönotto
Ohjelman asennus ja käyttöönotto sillä tavoin, että peruskäyttäjäkin ymmärtää. Esim. "Mene hakemistoon x" tai "luo kuvake tiedostoon y" ei riitä, vaan tarvitaan yksityiskohtaiset ohjeet.
3. Toiminnot
Tämä kohta riippuu suuresti ohjelman tyypistä, esimerkiksi hierarkisesti rakentuvasta kortisto-ohjelmassa voi olla hyvä raportoida omissa aliluvuissaan kunkin toiminnon käyttöohjeet, syötteet ja tulosteet, kun taas toiminnaltaan itsestään selvässä pelissä jaotus voisi olla uuden pelin aloittaminen - pelin kulku - asetusten muuttaminen - ohjelman lopetus. Joskus voi olla myös tarpeen selittää, mitä ohjelma ei tee eli sen rajoitukset. Näistä voi tarvittaessa tehdä myös oman luvun.
4. Ongelmatilanteet
4.1 Virheilmoitukset
Esimerkiksi taulukkona virheilmoitukset, niiden selitykset ja niiden vaatimat toimenpiteet.
4.2 Tyypilliset ongelmatilanteet ja niistä selviytyminen
Riippuu täysin ohjelmasta, esim. mitä tehdään tietoliikenneyhteyden katkettua kesken ohjelman suorituksen tai miten otetaan varmistustiedostosta tallennetut tiedot, jos käyttöjärjestelmä kaatuu.
4.3 Tunnetut virheet
"Ohjelma on täysin testattu ja todettu virheettömäksi"
5. Ylläpito
Vain siltäosin, kun loppukäyttäjän tarvitsee tietää, ohjelmakoodin muuttaminen yms. kuuluu rakenteen ja toiminnan kuvaukseen. Aiheita voisivat olla esimerkiksi uuteen version päivittäminen ja havaituista virheistä raportoiminen ohjelman tekijälle.