Kuidas luua Kasutaja Dokumentatsiooni

Kirjutamine dokumentatsiooni selle kohta, kuidas kasutada arvutiprogrammi on kriitiline nii lõppkasutaja ja keegi üritab koolitada üksikisikute uue programmi.Dokumentatsioon peab olema selge ja kergesti mõistetav.Sa ei taha oma kasutajatel on ära arvata, kuidas kasutada oma programmi.Kasutaja dokumentatsioon vajab tasakaalu nii kirjaliku ja visuaalse samme.Järgmised sammud antakse ülevaade sellest, kuidas luua standard kasutaja teatmik.

, mida te vajate

  • Arvutiprogramm
  • pliiats ja paber
  • Küljendusprogrammina tarkvara

juhised

  1. Kirjutage lühikirjeldus endale programmi --- hulka oma eesmärki, mida platvormid programmi kestab ja mis tahes mälu nõuetele.Nimekiri mitu bullet punkte, milles põhijooned programmi.

  2. visandada, kuidas soovite dokumentatsiooni otsima.Kaasa kõik võimalikud päised ja jalused panna jooksul dokumentatsiooni, leheküljenumbrid ja kuidas kate peaks otsima.See ülevaade aitab ka sind panna reisiraamat koos.

  3. Kirjutage oma esimeses ja

    os - kuidas installida programmi.Riigi iga samm selgelt sisestamist laserplaadil arvutisse, et mida teha, kui tarkvara on installitud.Pakkuda ekraanipilt paigaldamise käigus.Ärge jätke ühtegi sammu ja loetleda kõiki võimalikke vigu, mis võivad tekkida.Kaasa graafiku veaotsingu nõuandeid.

  4. riik selgelt näpunäidet programmi käivitada.Kaasa mis ikooni klõpsata ja millised on peamised ekraanil näeb.Pakkuda ekraanipildi avamise ekraani.

  5. Kirjutage oma kolmanda osa - kuidas toimida programmi.Kirjeldage menüü funktsioone, kuidas pääseda abi, kui võimalik, kuidas salvestada faile, kuidas printida, kuidas väljuda programmi ja muid põhifunktsioone.Kaasa ekraanipilt kogu käesoleva paragrahvi ka.Kasuta lihtsat Inglise ja ei oota lõppkasutaja arvata midagi.Kui programm ühendab teise programmi või paketi seletada sellega seoses.

  6. koostada lihtsat sisukorra ja indeks kasutades märksõnu oma dokumentatsiooni.Kirjutage käesoleva paragrahvi kui sul on eespool core lõigud teinud.Indeks annab kasutajale kiire viis hankida teavet, ilma et otsida kogu reisiraamat.

  7. Loo terminite sõnastik tehnilisel sõnu või väljendeid, mis tuleb kindlaks määrata kasutaja.Järgmine, kujundada kaas minna ees reisiraamat.

  8. Muuda oma dokumentatsiooni - kontrollige oma õigekirja, grammatika ja üldist infovoogu.Teha muudatusi ja edasi dokumendid, et keegi oma tööd kontrollida.Trüki ja siduda lõplik versioon.

Resources

  • meetodid ja mehaanika loomine Usaldusväärne Kasutaja Dokumentatsiooni
486
0
0
Muu Arvuti Tarkvara