Toote dokumentatsioon
Aidake kasutajatel oma rakenduse toetatud ülesandeid täita
Andke kasutajatele praktilised juhendid, mis selgitavad rakenduse teekondi ja aitavad neil ülesandeid täita.
Muutke toote funktsionaalsus praktilisteks juhisteks
- Valmistage ette juhendi ulatus
Vaadake üle dokumentatsiooni jaotised ja nende sihtrühm.
- Vastake sisuküsimustele
Täpsustage töövoogusid ja teavet, mida juhend peaks selgitama.
- Jälgige avalikku teenust
Uurige ehituse edenemist ja dokumentatsioonisaidi aadressi.
Selgitage, kuidas rakendust kasutada
Dokumentatsioon täiendab tooteesitlust praktiliste juhistega. Alustage alustamisjuhendist, seejärel juhatage kasutajad läbi töövoogude, mida rakendus tegelikult toetab.
Dokumentatsiooni seadistus näitab jaotiste määratlusi ja küsimusi. Esitage kontekst, mis aitab ülesannet kasutaja keeles selgitada.
Hoidke juhend toimiva rakendusega seotud
Toetage esimest kasulikku tegevust. Alustamisjuhend annab uutele kasutajatele lühikese tee tootesse. See peaks selgitama, kust alustada, millist teavet on vaja ja milline tulemus kinnitab ülesande lõpetamist.
Selgitage korduvat töövoogu. Üksikasjalik juhend järgib rakenduse tegelikke silte ja toiminguid. Eeltingimused, nummerdatud sammud ja oodatav tulemus aitavad äriülesannet korrata, tõlgendamata ekraani üldist kirjeldust.
Vastake läbivale küsimusele. Mõned küsimused puudutavad kontosid, kulusid või avaldamist, mitte üht ekraani. KKK annab lühikese vastuse ja lingib asjakohase juhendi juurde, hoides protseduuri ühes kohas, selle asemel et seda saidil dubleerida.
Hoidke juhendid tootega seotud
Vaadake dokumentatsioon üle pärast olulist rakenduse muudatust. Juhend peaks kasutama silte ja käitumist, mida kasutajad tegelikult näevad.
Dokumentatsioon töötab oma avalikul teenusel. Linkige see veebisaidilt ja kontrollige juhendeid keeltes, milles teie projekt avaldab.
Aidake kasutajal järgmine ülesanne lõpetada
Praktiline juhend selgitab, kust alustada, millist teavet on vaja ja kuidas tulemust kontrollida. Selle väärtus seisneb selles, et see aitab lugejal rakenduses tegutseda.
Kasutage seotud juhendeid teekonna jätkamiseks, kui ülesanne hõlmab mitut valdkonda. Vaadake dokumentatsioon üle, kui ekraan muutub, et juhised jääksid pärast arengut kasulikuks.
Kokkulepitud funktsionaalsusest kasuliku abini
Valmistage ette juhendi ulatus. Vaadake üle dokumentatsiooni jaotised ja ülesanded, mida need peaksid selgitama. Hoidke sihtkasutaja ja rakenduse käitumine selged.
Andke puuduv kontekst. Vastake küsimustele eeltingimuste, reeglite ja tulemuste kohta. Tekst peaks kasutama tegelikku liidest, mitte väljamõeldud juhtelemente.
Ülevaatus pärast avaldamist ja muudatust. Järgige rakenduses juhendit, kontrollige selle keeli ja seotud linke ning vaadake see uuesti üle, kui aluseks olev ülesanne muutub.
Muutke toode pärast esimest külastust kergemini kasutatavaks
Esitage juhised, mis viivad tulemuseni, koos avaliku esitlusega sellest, mida rakendus teeb.
Küsimused toote dokumentatsiooni kohta
Funktsioonileht aitab potentsiaalsel kliendil mõista võimalust ja selle väärtust. Juhend aitab kasutajal ülesannet täita tegelike juhtelementide, eeltingimuste ja tulemusega. Need täiendavad teineteist.
Dokumentatsiooni tööriistad näitavad jaotiste määratlusi ja küsimusi. Vaadake üle rakenduse toetatud ülesanded, esitage puuduv kontekst ja jälgige kirjutamise edenemist.
Projekt avaldab oma ulatuse jaoks saadaolevad lokaliseeritud juhendid. Vaadake üle iga avaldatud keel, et see säilitaks täieliku protseduuri ja õiged liidese sildid.
Pärast muudatust, mis mõjutab ülesannet, selle juhtelemente või oodatavat tulemust. Kontrollige teksti töötava rakenduse põhjal, selle asemel et eeldada, et algsed juhised kehtivad endiselt.
Lõpp-punkti viide kuulub projektile, millel on aktiivne ja toimiv API. Kasutage selle avaldatud toiminguid ja tegelikku viidet; kavandatud marsruutidest ei piisa kasutatava integratsiooni dokumenteerimiseks.