Usein täynnä ammattikieltä, lyhenteitä ja ohjeita, jotka edellyttävät tohtorin ymmärtämistä, ohjelmiston käyttöoppaat kirjoitetaan joskus kehittäjän eikä käyttäjän näkökulmasta. Tämän seurauksena opas voi tehdä oletuksia lukijan taitotasosta, joka on usein virheellinen. Ensimmäisen askeleen kirjoittaminen hyvästä käyttöoppaasta on saada todellinen kirjoitusprosessi mahdollisimman kauas insinööreistä.
Ohjelmistokehittäjä tietää enemmän kuin kukaan, mikä tekee ohjelmistosta työtä, mutta se ei tarkoita sitä, että kehittäjän tulisi kirjoittaa opas. Päinvastoin, se on selvä haitta. Tärkeämpi kuin syvällinen ymmärtäminen ohjelmiston sisäisestä toiminnasta on ymmärtää, kuka loppukäyttäjä on, mitä hänen koulutustaso on ja miten loppukäyttäjä käyttää ohjelmistoa. Useimmissa tapauksissa loppukäyttäjien ei tarvitse tietää ohjelmiston tarkempia pisteitä ja ohjelmiston back-end-toimintoja - niiden on vain tiedettävä, miten sitä voidaan käyttää työnsä helpottamiseksi.
Käyttäjän testaus
Käyttöohjeen tulisi olla suurelta osin tehtäväkeskeinen eikä niinkään kuvaileva. Koska käsikirja on kirjoitettu auttamaan käyttäjiä ymmärtämään, miten tiettyjä tehtäviä suoritetaan, kirjoittajan on ymmärrettävä myös nämä tehtävät ja sen seurauksena kunkin ominaisuuden kunkin erillisen vaiheen käyminen on ehdottoman välttämätöntä. Kirjoittajan ei tarvitse välttämättä tietää, miten ohjelma luotiin suunnittelun tai kehityksen näkökulmasta, mutta on välttämätöntä, että kaikilla sen ominaisuuksilla on vahva työskentelyosa. Kun jokainen tehtävä suoritetaan, kirjoita jokainen vaihe, mukaan lukien napsautukset, pudotusvalikot ja muut toimet.
Haastatteluprosessi
Vaikka kehittäjän ei pitäisi kirjoittaa käsikirjaa, hän on edelleen arvokas resurssi kirjailijalle ja suunnittele ennen kirjoittamisen aloittamista kirjoittajan, kehittäjän ja insinöörien ja potentiaalisten loppukäyttäjien käynnistyskokous. kirjailijan työ alusta alkaen. Aihealueiden asiantuntijoiden ja insinöörien haastattelut on kirjattava, ja niiden on oltava myöhempää käyttöä varten.
kuvakieli
Käyttäjän käsikirjan ei pitäisi olla liian tekstiä. Sisällytä pikemminkin grafiikan ja näytön leikkeiden liberaali käyttö. Toimenpiteen kuvaus on paljon selkeämpi tekstisuuntaisilla suuntaviivoilla ja näytön leikkeellä, joka osoittaa selvästi tätä suuntaa. Sisällytä sekä ennen että jälkeen näkymiä, jotta näytetään, mitä näyttö näyttää ennen jokaista toimintaa, ja mitä tapahtuu sen jälkeen, kun toiminto on tehty. Yksinkertainen kuvakaappausapuohjelma, kuten Microsoft Windows -käyttöjärjestelmässä oleva Snipping-työkalu, toimii hyvin näiden kuvien tallentamiseen. Muista numeroida jokainen kuva ja sisällyttää siihen lyhyt kuvaus. Keskitä se välittömästi sen kohdan alapuolelle, joka esittelee ensin kuvassa esitetyn käsitteen.
alustus
Tiedonanto selkeästi teknisessä asiakirjassa edellyttää suunnittelua ja standardien huolellista noudattamista koko oppaassa. Sekä esityksen, kielen että nimikkeistön standardit auttavat välttämään sekaannusta. Mallit ovat saatavilla ja ne voivat olla hyvä lähtökohta yhtenäisyydelle, vaikka niitä voidaan varmasti mukauttaa kunkin tilanteen mukaan. Yhden tuuman marginaalin käyttäminen yhdellä sarakkeella sopii parhaiten grafiikan lisäämiseen; kahden sarakkeen asetus saattaa tuntua liian täynnältä, ja se voi tehdä kuvien sijoittelusta sekaannusta.
Versio ja seuranta
Enemmän kuin mikään muu asiakirjatyyppi, ohjelmistokäyttäjän opas menee todennäköisesti useaan kertaan, ennen kuin se on valmis, ja useat sidosryhmät saattavat todennäköisesti käydä läpi tarkistusprosessin. Microsoft Wordin Track Changes -toiminnon käyttäminen on helppo tapa seurata kunkin henkilön kommentteja ja muutoksia. Useiden versioiden luominen jokaisen tarkistusjakson jälkeen, joista jokaisella on eri tiedostonimi, auttaa myös prosessia ja varmistaa, että kaikki sidosryhmät ovat tyytyväisiä lopputulokseen.
