Dokumentacioni i produktit
Ndihmoni përdoruesit të përfundojnë detyrat që aplikacioni juaj mbështet.
Ofroni udhëzime praktike për përdoruesit që shpjegojnë rrugët e aplikacionit dhe i ndihmojnë ata të përfundojnë detyrat e tyre.
Kthejeni funksionalitetin e produktit në udhëzime praktike
- Përgatitni fushën e vizorit
Rishikoni seksionet e dokumentacionit dhe audiencën e tyre të synuar.
- Përgjigjuni pyetjeve të përmbajtjes
Qartësoni rrjedhjet e punës dhe informacionin që një udhëzues duhet të shpjegojë.
- Ndiqni shërbimin publik
Kontrolloni përparimin e ndërtimit dhe adresën e faqes së dokumentacionit.
Shpjegoni se si të përdorni aplikacionin
Dokumentacioni plotëson prezantimin e një produkti me udhëzime praktike. Filloni me udhëzimet e fillimit, më pas udhëzoni përdoruesit përmes rrjedhave e punës që aplikacioni në të vërtetë i mbështet.
Konfigurimi i dokumentacionit ekspozon definimet e seksioneve dhe pyetjet. Furnizoni kontekst që ndihmon në shpjegimin e një detyre në gjuhën e përdoruesit.
Mbajeni udhëzuesin të lidhur me aplikacionin që po përdorni
Mbështesni një veprim të parë të dobishëm. Një udhëzues fillestar i jep përdoruesve të rinj një rrugë të shkurtër drejt produktit. Ai duhet të shpjegojë ku të fillojnë, cilat informacione kërkohen dhe cili rezultat konfirmon se detyra është përfunduar.
Shpjegoni një rrjedhë pune periodike. Një udhëzues i detajuar ndjek etiketat dhe veprimet reale të aplikimit. Parakushtet, hapat e numëruar dhe rezultati i pritur ndihmojnë dikë të përsërisë një detyrë biznesi pa interpretuar një përshkrim të përgjithshëm të ekranit.
Përgjigjuni një pyetjeje që trajtohet në të gjitha fushat. Disa pyetje kanë të bëjnë me llogaritë, kostot ose publikimin, jo vetëm me një ekran. Një FAQ ofron një përgjigje të shkurtër dhe lidhje me udhëzuesin përkatës, duke mbajtur procedurën në një vend, në vend që ta përsërisë në të gjithë ueb-faqen.
Mbani udhëzuesit të lidhur me produktin
Rishikoni dokumentacionin pas një ndryshimi të rëndësishëm në aplikacion. Një udhëzues duhet të përdorë etiketat dhe sjelljen që përdoruesit mund ta shikojnë vërtet.
Dokumentacioni ekzekutohet në shërbimin e tij publik. Lidhni atë nga faqja e internetit dhe kontrolloni udhëzimet në gjuhët në të cilat projekti juaj publikohet.
Ndihmojeni një përdorues të përfundojë detyrën e radhës
Një udhëzues praktik shpjegon nga të fillohet, çfarë informacioni nevojitet dhe si të kontrollohet rezultati. Vlera e tij vjen nga ndihma që i jep lexuesit për të vepruar në aplikacion.
Përdorni udhëzuesit e lidhur për të vazhduar rrugëtimin kur detyra përshkon disa fusha. Rishikoni dokumentacionin kur ndryshon një ekran, që udhëzimet të mbeten të dobishme pas një zhvillimi.
Nga funksionaliteti i dakorduar në ndihmë të dobishme
Përgatitni fushën e shikimit. Rishikoni seksionet e dokumentacionit dhe detyrat që ato duhet të shpjegojnë. Mbani të qartë përdoruesin e synuar dhe sjelljen e aplikacionit.
Sigurojeni kontekstin e munguar. Përgjigjuni pyetjeve rreth parakushteve, rregullave dhe rezultateve. Shkrimi duhet të përdorë ndërfaqen reale dhe jo kontrolle të trilluara.
Rishikoni pas publikimit dhe ndryshoni.. Ndërqitni një udhëzues në aplikacion, kontrolloni gjuhët dhe lidhjet e tij, dhe më pas rishikojeni kur detyra themelore ndryshon.
Bëni produktin më të lehtë për t'u përdorur pas vizitës së parë
Jepni udhëzime që çojnë në një rezultat, së bashku me prezantimin publik të asaj që aplikacioni bën.
Pyetje rreth dokumentacionit të produktit
Një faqe karakteristike ndihmon një klient potencial të kuptojë aftësinë dhe vlerën e saj. Një udhëzues ndihmon një përdorues të kryejë detyrën, me kontrollet aktuale, parakushtet dhe rezultatin. Ato plotësojnë njëra-tjetrën.
Dokumentacioni ofron përcaktime seksionesh dhe pyetje. Rishikoni detyrat që aplikacioni mbështet, siguroni kontekstin e nevojshëm dhe ndiqni përparimin e shkrimit.
Projekti publikon udhëzimet e lokalizuara të disponueshme për fushën e tij. Rishikoni çdo gjuhë të publikuar në mënyrë që të ruajë procedurën e plotë dhe etiketat e duhura të ndërfaqes.
Pasi ndodh një ndryshim që ndikon në detyrën, kontrollet e saj ose rezultatin e pritur. Kontrolloni tekstin kundrejt aplikacionit që funksionon, në vend që të supozoni se udhëzimet origjinale mbeten të vlefshme.
Një referencë përfundimtare i përket një projekti me një API aktive dhe që funksionon. Përdorni operacionet e tij aktuale dhe referencën reale; rrugët e planifikuara nuk janë të mjaftueshme për të dokumentuar një integrim të përdorshëm.