Miten KirjoitaKäyttöohje Ohjelmiston

Nainen työskenteleetietokoneella . Colorblind Images / Blend Images / Getty Images

usein täynnä ammattikieltä, lyhenteitä ja ohjeet, jotka vaativat Ph.D ymmärtää, ohjelmisto käyttöohjeet ovat joskus kirjoitettu näkökulmasta kehittäjäsen sijaan käyttäjälle.Tämän seurauksena opas voi tehdä oletuksia lukijan taitotason jotka ovat usein virheellisiä.Ensimmäinen askel kirjallisesti hyvä käyttäjän käsikirja on saada todellista kirjoittamista niin kauas insinöörejä kuin mahdollista.


ohjelmistokehittäjä tietää enemmän kuin kukaan mikä tekee ohjelmisto työtä, mutta se ei tarkoita kehittäjä pitäisi kirjoittaa opas.Päinvastoin, se on selvä haitta.Tärkeämpää kuin syvä ymmärrys sisäkorvan toiminnasta ohjelmisto on käsitys siitä, kuka loppukäyttäjä on, mitä hänen koulutustaso on, ja miten tämä loppukäyttäjä tulee käyttämään ohjelmistoa.Useimmissa tapauksissa kuluttajat eivät tarvitse tietää hienouksista ohjelmointi ja back-end toimintaa ohjelmisto - ne tarvitsee vain osata käyttää sitä tehdä työnsä helpompaa.

Käyttäjätestaus

  • ohjekirjat olisi suurelta osin tehtävä suuntautunut, eikä raskaasti kuvaileva.Koska Käsikirja on auttaa käyttäjiä ymmärtämään, miten suorittaa tiettyjä tehtäviä, kirjailija tarvitsee selvittävät näitä tehtäviä hyvin, ja sen seurauksena, läpi erillisten vaihe kukin ominaisuus on ehdottoman välttämätöntä.Se ei ole tarpeen kirjailija välttämättä tiedä miten ohjelma luotiin suunnittelu tai kehittäminen näkökulmasta, mutta on tärkeää olla vahva käytännön tuntemus kaikkia sen ominaisuuksia.Suoritettaessa kunkin tehtävän, vie aikaa kirjoittaa jokaisen vaiheen, mukaan lukien napsautukset, pudotusvalikoista, ja muita toimia.

haastattelussa

  • Vaikka kehittäjä ei pitäisi olla yksi kirjoittaa käsikirja, hän on silti arvokas voimavara kirjailija, ja ennen kirjoittaminen alkaa, suunnitelma alku tapaaminen kirjailija, kehittäjä jainsinöörejä, ja mahdolliset loppukäyttäjät auttaa ilmoittaa kirjailijan työhön alusta alkaen.Haastattelut aiheen asiantuntijoita ja insinöörejä on kirjattava, ja selostukset tehty myöhempää käyttöä varten.

-kuvat

  • käyttöoppaan ei saisi olla liian teksti-raskas.Pikemminkin sisällyttää vapaiden käyttö grafiikan ja näyttö leikkeitä.Kuvaus toiminta on paljon selkeämpi teksti-pohjainen suuntiin mukana näytön leikkeen, joka osoittaa selvästi, että suunta.Sisältävät sekä ennen ja jälkeen näkymät, näyttää, mitä ruudulla näkyy ennen kunkin toimen, ja mitä tapahtuu, kun toimenpide on toteutettu.Yksinkertainen kuvakaappaus apuohjelma kuten Snipping Tool sisältyi Microsoft Windows toimii hyvin kaappaaminen nämä kuvat.Muista numeroon jokaisen kuvan, ja sisältävät kuvateksti joka lyhyesti kuvaa sitä.Keskitä se välittömästi sen alapuolella kohdassa, että ensimmäinen otetaan käyttöön käsite kuvattu kuvan.

Muotoilu

  • viestintä selvästi teknisessä asiakirja vaatii suunnittelua ja huolellista noudattamista standardeja kaikkialla oppaassa.Standardit molemmissa esityksen, kieli, ja nimikkeistön apua sekaannusten välttämiseksi.Mallit ovat saatavilla ja voi olla hyvä lähtökohta yhdenmukaisuus, vaikka nämä voidaan varmasti sovittaa sopimaan kuhunkin tilanteeseen.Käyttämällä yhden tuuman marginaali yhdellä sarake sopii parhaiten tarvetta lisätä grafiikkaa;kahden sarakkeen asetus saattaa vaikuttaa liian täynnä, ja voi tehdä sijoittamisesta kuvia hämmentävää.

versiointi ja seuranta

  • Enemmän kuin mikään muu asiakirja, ohjelmisto käyttäjän opas on todennäköisesti mennä läpi useita toistojen ennen kuin se on valmis, ja se on todennäköisesti mennä läpi arviointiprosessin useita sidosryhmiä.Käyttäen Jäljitä muutokset ominaisuus Microsoft Word on helppo tapa seurata kunkin yksittäisen kommentit ja muutokset.Luominen useita versioita jokaisen tarkastelun sykli, joilla on erilainen tiedoston nimi, myös auttaa prosessia pitkin ja varmistaa kaikki sidosryhmät ovat tyytyväisiä lopputulokseen.

Resurssit

  • Techcommunicators.com: Kirjoittaminen tarkistettavissa Käyttöohjeet
589
0
1
Tuotehallinta