Kuidas kirjutada Kasutusjuhend Tarkvara

Naine töötab arvutis . värvipime Images / Blend Images / Getty Images

Sageli täis kõnepruuki, lühendite ja suunad, mis vajavad Ph.D mõista, tarkvara kasutusjuhendite mõnikord kirjutatud seisukohalt arendajamitte alla.Selle tulemusena võib suunav teha oletusi lugeja oskuste tase, mis on sageli vale.Esimene samm kirjutamise hea kasutusjuhendis on saada tegelikku kirjutamise protsessi nii kaugel insenerid kui võimalik.


Tarkvara arendaja teab rohkem kui keegi teebki tarkvara töö, kuid see ei tähenda, et arendaja peaks juhendi kirjutajad.Vastupidi, see on selgelt halvemasse olukorda.Tähtsam kui sügav mõistmine tööst tarkvara on arusaam, kes lõppkasutaja on, millised on tema haridustase ning kuidas see Lõppkasutaja tarkvara abil.Enamasti lõppkasutajad ei pea teadma, peenemad kohad programmeerimine ja back-end töös tarkvara - nad lihtsalt vaja teada, kuidas seda kasutada, et muuta oma töö lihtsamaks.

tajatestide

  • Kasutusjuhendis peab olema suuresti ülesanne orienteeritud, mitte tugevalt kirjeldav.Kuna juhend on kirj

    utatud, et aidata kasutajatel mõista, kuidas täita eriülesandeid, kirjanik peab olema arusaam neid ülesandeid hästi ning selle tulemusena läbimas kõik diskreetsed samm iga funktsioon on hädavajalik.See ei ole vajalik kirjanik pruugi teada, kuidas programm loodi disaini või arengu seisukohalt, kuid see on oluline omada tugevat tööoskusi kõik selle iseärasusi.Kuigi täidesaatva iga ülesande, võtta aega, et kirjutada iga samm, sealhulgas hiireklõpsu, ripp-menüüsid ja muid tegevusi.

intervjuu käigus

  • Kuigi arendaja ei peaks olema see, kes kirjutavad käsitsi, ta ikkagi väärtuslik ressurss kirjanik ja enne kirjutamise alustamist, planeerida Käivitus kohtumine kirjanik, arendaja jainsenerid ja võimalikud lõppkasutajad aidata teavitada kirjaniku töö algusest.Intervjuud teema eksperdid ja insenerid tuleks registreerida, ärakirju tehtud edasipidiseks.

Imagery

  • A kasutusjuhendis ei tohiks olla liiga teksti raske.Pigem lisada liberaalne kasutamine graafika ja ekraani klippe.Kirjeldus hagi on palju selgem teksti põhjal suundades kaasas ekraani clip, et selgelt on näha, et suund.Kaasa nii enne kui ka pärast vaatamist, et näidata, mida ekraanil välja näeb enne iga tegevus, ja mis juhtub pärast meetmed on võetud.Lihtne ekraani püüdmise kasuliku nagu Lõiketööriist sisaldub Microsoft Windows töötab hästi hõivamiseks neid pilte.Kindlasti number iga pilt ja lisada pealdist, mis kirjeldab lühidalt seda.Keskel see kohe alla punkt, et esimene kasutusele mõiste kujutatud pildil.

Formatting

  • Suhtlemine selgelt tehniline dokument nõuab planeerimist ja hoolikalt järgida standardeid kogu juhend.Standardid nii esitlus, keele ja nomenklatuur abi vältida segadust.Mallid on olemas ja saab hea lähtepunkt ühtsus, kuigi need on kindlasti võimalik kohandada, et see sobiks igas olukorras.Kasutades üht-tolline marginaal ühe veeru kõige paremini sobib vaja lisada graafikat;kahe veerus sätet võib tunduda liiga rahvarohke ja teha paigutamine pilte segane.

Versioning ja Tracking

  • Rohkem kui mistahes muud tüüpi dokument, tarkvara kasutusjuhend on tõenäoliselt läbida mitmes variandis, enne kui ta on valmis, ja see on tõenäoliselt läbida läbivaatamise käigus mitme sidusrühmadega.Kasutades muutuste jälgimist Microsoft Word on lihtne jälgida iga kommentaarid ja muutusi.Luua mitu versiooni pärast iga läbivaatamise jooksul, millest igaüks on eri faili nimi, aitab protsessi koos ja teeb kindlaks, et kõik sidusrühmad on rahul lõpptulemusega.

Resources

  • Techcommunicators.com: Kirjutamine muudetavas Juhendid
53
0
1
Tootehaldus