Käyttöohjedokumentti

Sovelluksen käyttöohjedokumentin täytyy olla tehty hyvän tekstinkäsittelyn perusideologian mukaisesti ja sen täytyy olla kielellisesti sujuvaa. Dokumentissa pitää kiinnittää huomiota sekä dokumentin sisältöön että rakenteeseen. Edellisinä vuosina harjoitustyö on yleensä jäänyt kiinni tekstinkäsittelyosasta, joten sen merkitystä ei kannata vähätellä!

Dokumentaation tekeminen kannattaa aloittaa jo sovelluksen tekemisen yhteydessä, jolloin dokumenttiin kirjataan kuvauksia vastaan tulleista vaikeuksista. Dokumentti palautetaan harjoitustyön tarkistajalle sähköisessä muodossa, mutta dokumentin kansilehti palautetaan paperille tulostettuna. Tulostettu kansilehti sekä harjoitustyön hyväksytty suunnitelma arkistoidaan hyväksytystä harjoitustyöstä varmuuden vuoksi.

Käyttöohjeen sisällölliset vaatimukset

Käyttöohjedokumentin täytyy sisältää seuraavat asiat:

• Kansilehti (samassa tiedostossa varsinaisen dokumentin kanssa), jossa
  • työn nimi,
  • suunnitelman hyväksyjän nimi,
  • paikka harjoitustyön tarkastusmerkinnöille (päivä ja tarkastajan allekirjoitus),
  • tekijän koko nimi,
  • henkilötunnus (kokonaan),
  • sähköpostiosoite sekä
  • koko harjoitustyön tekemiseen kulunut aika.
• Lyhyet ja selkeät ohjeet sovelluksen käytöstä. Käyttöohjeiden täytyy olla riittävän selkeät, jotta niiden avulla voidaan käyttää sovellusta.
• Käyttöohjeista täytyy löytyä ohjetta selventäviä kuvia sovelluksesta. PrintScreen-näppäimellä saadaan koko näytön kuva kopioitua leikepöydälle. ALT-PrintScreen-näppäinyhdistelmällä saadaan kopioitua aktiivisen dialogin tai ikkunan sisältö leikepöydälle.
• Kommentteja sovelluksen tai jonkin muun harjoitustyön osan tekemisessä vastaantulleista vaikeuksista. Vaikeuksien tarkoituksena on antaa vinkkejä ja palautetta harjoitustyön kehittämiseksi. Vaikeudet kannattaa kuvata tarkasti!
• Omaan kokemuspohjaan perustuvia arvioita sovelluksen sopivuudesta käyttötarkoitukseen, johon se on tehty. Olisiko sovellus ollut parempi toteuttaa esimerkiksi tietokantojen avulla? Toteuttaisitko jonkin sovelluksen ominaisuuden tai osan nyt toisin?

Tekniset vaatimukset

• Asiakirja täytyy jakaa selkeästi lukuihin ja kappaleisiin.
• Asiakirjassa täytyy käyttää rakenteellisesti oikeita tyylejä oikeissa paikoissa.
  • Valmiita tyylejä käytetään aina kappaleissa, kun rakennetta vastaava tyyli on olemassa. Tälläisiä tyylejä ovat muun muassa erilaiset listatyylit (engl. List) ja otsikkotyylit (engl. Heading) sekä normaalityyli (engl. Normal). Tyylejä kannattaa muokata dokumenttiin paremmin soveltuviksi!
  • Uusia tyylejä tehdään vain kun rakenteellisesti oikeaa tyyliä ei löydy valmiina. Asiakirjaan täytyy tehdä vähintään kaksi uutta tyyliä, joista vähintään toisen on oltava merkkityyli. Asiakirjasta on varmasti löydettävissä rakenteellisesti kohtia, joissa uusien tyylien käyttö on järkevää. Esimerkiksi sovelluksen käyttöohjeen painikkeiden nimet.
• Ylä- tai alatunnisteessa sivunumerointi ja tekijän nimi.
• Dokumentin alkuun sisällysluettelo.
• Dokumentin loppuun hakemisto tärkeimmistä hakusanoista.
• Tekstiä tulee helposti noin kaksi A4-kokoista sivua + kansilehti + kuvat + sisällysluettelo + hakemistosivu eli yhteensä noin 7 sivua.