Dokumentacija proizvoda
Pomozite korisnicima da dovrše zadatke koje vaša aplikacija podržava
Pružite korisnicima praktične vodiče koji objašnjavaju tijekove aplikacije i pomažu im dovršiti zadatke.
Pretvorite funkcionalnost proizvoda u praktične upute
- Pripremite opseg vodiča
Pregledajte odjeljke dokumentacije i njihovu ciljanu publiku.
- Odgovorite na pitanja o sadržaju
Pojasnite tijekove rada i informacije koje vodič treba objasniti.
- Pratite javnu uslugu
Pregledajte napredak izrade i adresu web-stranice s dokumentacijom.
Objasnite kako se koristi aplikacija
Dokumentacija dopunjuje prezentaciju proizvoda praktičnim uputama. Počnite s uvodnim vodičem, a zatim vodite korisnike kroz tijekove rada koje aplikacija stvarno podržava.
Konfiguracija dokumentacije prikazuje definicije odjeljaka i pitanja. Navedite kontekst koji pomaže objasniti zadatak jezikom korisnika.
Održavajte vodič povezanim s aplikacijom koja radi
Podržite prvu korisnu radnju. Uvodni vodič novim korisnicima daje kratak put u proizvod. Treba objasniti odakle početi, koje su informacije potrebne i koji rezultat potvrđuje da je zadatak dovršen.
Objasnite ponavljajući tijek rada. Detaljni vodič slijedi stvarne oznake i radnje aplikacije. Preduvjeti, numerirani koraci i očekivani ishod pomažu ponoviti poslovni zadatak bez tumačenja općenitog opisa zaslona.
Odgovorite na sveobuhvatno pitanje. Neka se pitanja odnose na račune, troškove ili objavu, a ne na jedan zaslon. Česta pitanja daju sažet odgovor i poveznicu na odgovarajući vodič, tako da postupak ostaje na jednom mjestu umjesto da se ponavlja na web-stranici.
Održavajte vodiče povezanima s proizvodom
Pregledajte dokumentaciju nakon značajne izmjene aplikacije. Vodič treba koristiti oznake i ponašanje koje korisnici stvarno vide.
Dokumentacija radi na vlastitoj javnoj usluzi. Povežite je s web-stranice i provjerite vodiče na jezicima na kojima vaš projekt objavljuje.
Pomozite korisniku da dovrši sljedeći zadatak
Praktični vodič objašnjava odakle početi, koje su informacije potrebne i kako provjeriti rezultat. Njegova vrijednost je u tome što čitatelju pomaže djelovati u aplikaciji.
Koristite povezane vodiče za nastavak puta kada zadatak obuhvaća više oblasti. Pregledajte dokumentaciju kada se zaslon promijeni kako bi upute ostale korisne i nakon razvoja.
Od dogovorene funkcionalnosti do korisne pomoći
Pripremite opseg vodiča. Pregledajte odjeljke dokumentacije i zadatke koje trebaju objasniti. Neka ciljni korisnik i ponašanje aplikacije ostanu jasni.
Navedite kontekst koji nedostaje. Odgovorite na pitanja o preduvjetima, pravilima i ishodima. Tekst treba koristiti stvarno sučelje, a ne izmišljene kontrole.
Pregled nakon objave i izmjene. Slijedite vodič u aplikaciji, provjerite njegove jezike i povezane poveznice te ga ponovno pregledajte kada se temeljni zadatak promijeni.
Olakšajte korištenje proizvoda nakon prvog posjeta
Pružite upute koje vode do rezultata, uz javnu prezentaciju onoga što aplikacija radi.
Pitanja o dokumentaciji proizvoda
Stranica značajke pomaže potencijalnom klijentu razumjeti mogućnost i njezinu vrijednost. Vodič pomaže korisniku izvršiti zadatak, sa stvarnim kontrolama, preduvjetima i ishodom. Međusobno se nadopunjuju.
Alati za dokumentaciju prikazuju definicije odjeljaka i pitanja. Pregledajte zadatke koje aplikacija podržava, navedite kontekst koji nedostaje i pratite napredak pisanja.
Projekt objavljuje lokalizirane vodiče dostupne za svoj opseg. Pregledajte svaki objavljeni jezik kako bi zadržao cjelovit postupak i ispravne oznake sučelja.
Nakon izmjene koja utječe na zadatak, njegove kontrole ili očekivani rezultat. Provjerite tekst prema aplikaciji koja radi umjesto da pretpostavite da izvorne upute i dalje vrijede.
Referenca krajnje točke pripada projektu s aktivnim, funkcionalnim API-jem. Koristite njegove aktivne operacije i stvarnu referencu; planirane rute nisu dovoljne za dokumentiranje upotrebljive integracije.