Dokumentacija proizvoda
Pomozite korisnicima da završe zadatke koje vaša aplikacija podržava
Pružite korisnicima praktične vodiče koji objašnjavaju procese u aplikaciji i pomažu im da obave zadatke.
Pretvorite funkcionalnost proizvoda u praktična uputstva
- Pripremite opseg vodiča
Pregledajte odeljke dokumentacije i ciljnu publiku.
- Odgovarajte na pitanja u vezi sa sadržajem
Razjasnite tokove rada i informacije koje bi vodič trebao da objasni.
- Pratite javnu uslugu
Proverite napredak izrade i adresu sajta sa dokumentacijom.
Objasnite kako se koristi aplikacija
Dokumentacija dopunjuje prezentaciju proizvoda praktičnim uputstvima. Započnite sa osnovama, a zatim vodite korisnike kroz tokove rada koje aplikacija zapravo podržava.
Konfiguracija dokumentacije prikazuje definicije sekcija i pitanja. Navedite kontekst koji pomaže da se objasni zadatak na jeziku korisnika.
Držite vodič povezan sa aplikacijom u kojoj radite
Podržite prvo korisno dejstvo. Vodič za početnike pruža novim korisnicima kratak put do upoznavanja sa proizvodom. Trebalo bi da objasni odakle da počnu, koje su informacije potrebne i koji rezultat potvrđuje da je zadatak završen.
Objasnite ponavljajući tok rada. Detaljan vodič prati stvarne nalepnice i radnje aplikacije. Preduslovi, numerisani koraci i očekivani rezultat pomažu nekome da ponovi poslovni zadatak bez tumačenja opšteg opisa ekrana.
Odgovorite na sveobuhvatno pitanje. Neka od njih se odnose na naloge, troškove ili objavljivanje, a ne na jedan ekran. Često postavljana pitanja pružaju kratak odgovor i linkove do relevantnog vodiča, držeći proceduru na jednom mestu umesto da se duplira širom sajta.
Nastavite da su priručnici povezani sa proizvodom
Pregledajte dokumentaciju nakon značajnije promene aplikacije. Vodič bi trebao koristiti oznake i ponašanje koje korisnici zaista mogu da vide.
Dokumentacija radi na sopstvenoj javnoj usluzi. Povežite je sa veb-lokacijem i proverite vodiče na jezicima na kojima vaš projekat objavljuje sadržaj.
Pomozite korisniku da završi sledeći zadatak
Praktičan vodič objašnjava gde početi, koje su informacije potrebne i kako proveriti rezultat. Njegova vrednost proizilazi iz pomoći čitaocu da preduzme akciju u aplikaciji.
Koristite srodne vodiče da biste nastavili put kada se zadatak odnosi na više oblasti. Pregledajte dokumentaciju kada se promeni ekran, kako bi uputstva ostala korisna i nakon izmena.
Od dogovorene funkcionalnosti do korisne pomoći
Pripremite opseg za podešavanje. Pregledajte odeljke dokumentacije i zadatke koje bi trebali da objašnjavaju. Održavajte jasnu sliku o krajnjem korisniku i željenom ponašanju aplikacije.
Navedite nedostajeci kontekst. Odgovarajte na pitanja o uslovima, pravilima i rezultatima. Tekst treba da koristi pravi interfejs, a ne izmišljene kontrole.
Pregled nakon objavljivanja i izmena. Pratite vodič u aplikaciji, proverite njene jezike i povezane linkove, a zatim ga ponovo posetite kada se osnovni zadatak promeni.
Učinite proizvod jednostavnijim za korišćenje nakon prve posete
Dajte instrukcije koje dovode do željenog rezultata, zajedno sa javnim prikazom toga šta aplikacija radi.
Pitanja o dokumentaciji proizvoda
Stranica sa karakteristikama pomaže potencijalnom korisniku da razume mogućnosti i njihovu vrednost. Vodič pomaže korisniku da obavi zadatak, sa stvarnim kontrolama, uslovima i ishodom. Oni se međusobno dopunjuju.
Dokumentacioni alati prikazuju definicije sekcija i pitanja. Pregledajte zadatke koje aplikacija podržava, dodajte nedostajući kontekst i pratite tok pisanja.
Projekat objavljuje lokalizovane vodiče dostupne za njegovu namenu. Pregledajte svaki objavljeni jezik kako bi se osiguralo da sadrži kompletan postupak i ispravne oznake interfejsa.
Nakon izmene koja utiče na zadatak, njegove kontrole ili očekivani rezultat. Proverite tekst u odnosu na funkcionišuću aplikaciju, umesto da pretpostavljate da su originalna uputstva i dalje važeća.
Referenca krajnje tačke pripada projektu sa aktivnim, funkcionalnim API-jem. Koristite njene trenutne operacije i stvarnu referencu; planirane rute nisu dovoljne za dokumentovanje upotrebljive integracije.