Vaikka monet tietokoneen käyttäjät jättävät usein huomiotta, ohjetiedostot antavat tärkeitä tietoja siihen liittyvän ohjelmistosovelluksen käytöstä. Napsauttamalla "Ohje" käyttäjä voi saada yleiskatsauksen ohjelman ominaisuuksista, kuvauksen näytöstä, jota hän katselee, ohjeet ohjelman käyttämiseen tietyn tehtävän suorittamiseen tai lukea luetteloita usein kysytyistä kysymyksistä. ohjelma ja niiden vastaukset. Ohjetiedoston kirjoittaminen edellyttää sekä kykyä työskennellä ohjelmistosovellusten kanssa että kykyä selittää asiat käyttäjien ymmärtämällä tavalla.
Askeleet
Vaihe 1. Hanki kopio ohjelmistosta, jonka haluat dokumentoida
Jos mahdollista, sinun pitäisi myös saada kopio ohjelman kirjallisista tiedoista, vaikka kaikki ohjelmistokehittäjät eivät toimi niiden kanssa. Joissakin tapauksissa ohjelmoija poikkeaa teknisistä tiedoista johtuen lyhyestä kehitysajasta tai siitä, ettei hän voi koodata tiettyä ominaisuutta.
Vaihe 2. Hanki ohjeiden luomistyökalu
Vaikka on mahdollista luoda ohjetiedosto käsin käyttämällä Rich-Text-muotoista (.rtf) -tiedostoa, useimmat ohjetiedostojen kirjoittajat käyttävät ohjetiedostoja ohjelmistosovelluksella, kuten RoboHelp, Help and Manual, Doc-To -Help, MadCap Flare tai HelpLogix. Useimmat aputyökalut sisältävät tekstieditorin tai työskentelevät tekstinkäsittelyohjelman, kuten Microsoft Wordin, kanssa ja tarjoavat käyttöliittymän, jonka avulla ohjekirjoittaja voi nähdä miltä ohjetiedosto näyttää kirjoittaessaan sitä samalla kun hän kirjoittaa tietokoneen koodia kulissien takana jotta ohjetiedosto toimisi. Joissakin ohjeiden luomistyökaluissa on myös grafiikkaeditorit, joiden avulla voit luoda kuvakaappauksia ohjetiedostoon.
Ohjetiedostomuotoja on useita: Yleisin on HTML -ohje, jota käyttävät Windows -sovellukset. (Vanhempaa muotoa, WinHelp, ei enää tueta.) Appleilla ja Unixilla on myös omat tiedostomuodot, samoin kuin Sun Microsystems JavaHelpillä. Ohjelmistosovellukset, jotka on suunniteltu toimimaan useiden käyttöjärjestelmien alla, voivat käyttää eri alustojen ohjejärjestelmää, joka toimii käyttäjän verkkoselaimessa. Minkä tahansa käyttämäsi aputyökalun pitäisi tukea ohjemuotoa, johon aiot luoda ohjetiedostoja
Vaihe 3. Luo ohjeprojektitiedosto
Ohjeiden luomistyökalu luo sinulle ohjekirjatiedoston antamasi tiedostonimen ja muiden tietojen perusteella. Pääprojektitiedosto sisältää tietoja muista tiedostoista, jotka sisältävät sisältötiedoston, hakemistotiedoston, yhden tai useamman kuvatiedoston ja muita tiedostoja.
- Sisältötiedosto sisältää ohjetiedoston tekstin, joka selittää, miten dokumentoitava sovellus toimii. Teksti jaetaan yleensä aiheisiin, jotka kattavat tietyn näytön, ominaisuuden tai menettelyn.
- Hakemistotiedosto on luettelo ohjetiedoston aiheista. Sitä käytetään sisällysluettelon luomiseen, jonka avulla käyttäjät voivat valita tarkasteltavan aiheen, sekä hakutiedoston ohjetiedostossa.
- Kuvatiedostot ovat graafisia tiedostoja ohjelmien näytöistä tai niiden osia, jotka näytetään ohjetiedostossa, jotta käyttäjät voivat paremmin ymmärtää, mihin ohjetiedoston teksti viittaa.
Vaihe 4. Säädä ohjeikkunan kokoa
Ellet kirjoita ohjetiedostoa näkymään käyttäjän verkkoselaimessa, ohjetiedosto tulee näkyviin omaan ikkunaansa. Ohjeiden luomistyökalun avulla voit säätää ikkunan vaaka- ja pystymitat sellaiseen kokoon, että loppukäyttäjä voi lukea ohjetiedoston ilman, että se häiritsee itse sovellusta. Ohjeen pääikkuna on usein kolmen ruudun muodossa, sisällysluettelo vasemmalla ja valittu aihe oikealla.
Ohjetiedostoissa voi olla pääikkunan lisäksi myös toissijaisia ikkunoita, jotka kuvaavat tiettyä ominaisuutta yksityiskohtaisesti, ja automaattisesti mitoitettuja ponnahdusikkunoita, jotka kuvaavat ominaisuuksia lyhyesti. Ohjetiedostoihin voi sisältyä myös upotettua tekstiä, joka näkyy vain, kun korostettua tekstiä tai painiketta napsautetaan
Vaihe 5. Kirjoita ohjeaiheet
Tätä varten sinun on tarkistettava tekniset tiedot tai itse ohjelma, jotta voit luoda aiheita, jotka dokumentoivat ohjelman näytöt ja ominaisuudet. Kun luot kutakin aihetta, ohjeiden luomistyökalu lisää ne ohjetiedoston sisällysluetteloon ja hakemistoon.
- Vaikka voit rakentaa sisällysluettelon matkan varrella, se auttaa jonkinlaisessa suunnitelmassa sen järjestämiseksi. Voit järjestää sisällysluettelon ohjelman näyttöjen, sen ominaisuuksien, käyttötapojen tai niiden yhdistelmien ympärille.
- Kun kirjoitat aiheita, harkitse ohjetiedoston muita tietoja, joihin käyttäjät haluavat päästä nopeasti käsiksi. Voit luoda hyppyjä tai hyperlinkkejä ohjetiedoston tekstiin, joka yhdistää aiheeseen, jolla on nämä tiedot.
Vaihe 6. Lisää tarvittaessa kuvakaappauksia
Monet ohjelman ominaisuudet selitetään parhaiten tekstin ja grafiikan yhdistelmällä. Voit luoda kuvakaappauksia joko apuohjelmistotyökalun mukana tulevalla sovelluksella tai erillisellä sovelluksella, kuten Microsoft Paint, Paint Shop Pro tai SnagIt.
- Teksti ja kuvakaappaukset tulee sijoittaa yhteen aiheeseen siten, että käyttäjät voivat nähdä kuvakaappauksen ja sitä tukevan tekstin ilman tarpeetonta vieritystä. Monissa tapauksissa haluat näyttää osan ohjelmanäytöstä koko näytön sijasta tai näyttää kuvakaappauksen pienempänä kuin alkuperäinen. Kuvakaappaussovelluksesi pitäisi pystyä muuttamaan kuvakaappauksen kokoa hämärtymättä tai menettämättä yksityiskohtia.
- Jos odotat muutoksia käyttöliittymään ohjelman testi- ja lopullisten versioiden välillä, sinun kannattaa ehkä estää kuvakaappausten luominen, kunnes sinulla on ohjelman lopullinen versio.
Vaihe 7. Luo tarvittaessa karttatiedosto
Joissakin ohjelmissa on "Ohje" -painikkeet, joiden avulla käyttäjä voi napsauttaa ja näyttää aiheen ohjetiedostossa, joka kuvaa nimenomaisesti näytön toimintaa. Aiheen näyttämistä tällä tavalla kutsutaan tilannekohtaiseksi ohjeeksi, ja se edellyttää karttatiedoston luomista, jotta ohjelmoija voi linkittää "Ohje" -painikkeen ohjetiedoston tiettyyn aiheeseen. Ohjeiden luomistyökalu voi luoda sellaisen sinulle tai ohjelmoija voi koodata sen ja antaa sen sinulle sisällytettäväksi ohjetiedostoon.
Vaihe 8. Käännä ohjetiedosto
Kääntäminen luo varsinaisen ohjetiedoston, joka tulee ohjelman mukana. Useimmissa ohjemuodoissa tämä sisältää kaikki ohjetiedoston luomisen yhteydessä luodut komponentitiedostot, vaikka jotkin kääntämättömät ohjemuodot edellyttävät myös yksittäisten ohjeaiheiden tiedostojen sisällyttämistä ohjelmaan.
Vaihe 9. Testaa ohjetiedosto
Kun olet koonnut ohjetiedoston, sinun on testattava se varmistaaksesi, että kaikki hyperlinkit muodostavat yhteyden aiottuihin aiheisiin ja että kaikki grafiikat näkyvät oikein. Ohjetiedosto on myös testattava sen varmistamiseksi, että sisältö on tarkkaa ja käyttäjille sopivaa ja yhtenäisessä muodossa. Haluat tarkistaa ohjetiedoston itse ja pyytää myös sovellusta testaavia ihmisiä tarkistamaan sen.
Suuremmissa ohjetiedostohankkeissa kääntäminen ja testaaminen ovat jatkuvia prosesseja. Haluat koota ohjetiedoston ja tarkistaa työsi useita kertoja ennen lopullisen version luomista
Vaihe 10. Anna ohjetiedosto kehittäjälle sisällytettäväksi ohjelmaan
Projektin luonteesta ja ohjetiedostomuodosta riippuen saatat joutua toimittamaan kehittäjälle useita tiedostoja, mukaan lukien karttatiedoston, jos aiheeseen liittyviä aiheita on.
