Produkta dokumentācija
Palīdziet lietotājiem paveikt uzdevumus, ko atbalsta jūsu lietotne
Sniedziet lietotājiem praktiskus ceļvežus, kas izskaidro lietotnes ceļus un palīdz paveikt uzdevumus.
Pārvērtiet produkta funkcionalitāti praktiskās instrukcijās
- Sagatavojiet ceļveža apjomu
Pārskatiet dokumentācijas sadaļas un to paredzēto auditoriju.
- Atbildiet uz satura jautājumiem
Precizējiet darbplūsmas un informāciju, kas jāizskaidro ceļvedim.
- Sekojiet publiskajam pakalpojumam
Aplūkojiet izveides gaitu un dokumentācijas vietnes adresi.
Izskaidrojiet, kā lietot lietotni
Dokumentācija papildina produkta prezentāciju ar praktiskām instrukcijām. Sāciet ar darba sākšanas ceļvedi, pēc tam vadiet lietotājus cauri darbplūsmām, ko lietotne patiešām atbalsta.
Dokumentācijas konfigurācija parāda sadaļu definīcijas un jautājumus. Sniedziet kontekstu, kas palīdz izskaidrot uzdevumu lietotāja valodā.
Saglabājiet ceļvedi saistītu ar strādājošo lietotni
Atbalstiet pirmo noderīgo darbību. Darba sākšanas ceļvedis jaunajiem lietotājiem sniedz īsu ceļu produktā. Tam jāpaskaidro, ar ko sākt, kāda informācija ir nepieciešama un kāds rezultāts apstiprina, ka uzdevums ir pabeigts.
Izskaidrojiet atkārtotu darbplūsmu. Detalizēts ceļvedis seko lietotnes faktiskajiem nosaukumiem un darbībām. Priekšnoteikumi, numurēti soļi un sagaidāmais iznākums palīdz atkārtot biznesa uzdevumu, neinterpretējot vispārīgu ekrāna aprakstu.
Atbildiet uz vispārēju jautājumu. Daži jautājumi attiecas uz kontiem, izmaksām vai publicēšanu, nevis vienu ekrānu. BUJ sniedz kodolīgu atbildi un saiti uz attiecīgo ceļvedi, saglabājot procedūru vienuviet, nevis dublējot to visā vietnē.
Saglabājiet ceļvežus saistītus ar produktu
Pēc būtiskām lietotnes izmaiņām pārskatiet dokumentāciju. Ceļvedī jāizmanto nosaukumi un darbība, ko lietotāji patiešām redz.
Dokumentācija darbojas savā publiskajā pakalpojumā. Pievienojiet uz to saiti no tīmekļa vietnes un pārbaudiet ceļvežus valodās, kurās publicē jūsu projekts.
Palīdziet lietotājam pabeigt nākamo uzdevumu
Praktisks ceļvedis paskaidro, ar ko sākt, kāda informācija ir vajadzīga un kā pārbaudīt rezultātu. Tā vērtība ir palīdzēt lasītājam rīkoties lietotnē.
Izmantojiet saistītos ceļvežus, lai turpinātu ceļu, ja uzdevums aptver vairākas jomas. Kad ekrāns mainās, pārskatiet dokumentāciju, lai instrukcijas pēc izmaiņām paliktu noderīgas.
No saskaņotas funkcionalitātes līdz noderīgai palīdzībai
Sagatavojiet ceļveža apjomu. Pārskatiet dokumentācijas sadaļas un uzdevumus, kas tām jāizskaidro. Saglabājiet skaidru paredzēto lietotāju un lietotnes darbību.
Sniedziet trūkstošo kontekstu. Atbildiet uz jautājumiem par priekšnoteikumiem, noteikumiem un iznākumiem. Tekstā jāizmanto reālā saskarne, nevis izdomātas vadīklas.
Pārskatīšana pēc publicēšanas un izmaiņām. Sekojiet ceļvedim lietotnē, pārbaudiet tā valodas un saistītās saites un pārskatiet to vēlreiz, kad mainās pamatā esošais uzdevums.
Padariet produktu vieglāk lietojamu pēc pirmā apmeklējuma
Sniedziet instrukcijas, kas ved pie rezultāta, līdzās publiskai prezentācijai par to, ko dara lietotne.
Jautājumi par produkta dokumentāciju
Funkcijas lapa palīdz potenciālajam klientam izprast iespēju un tās vērtību. Ceļvedis palīdz lietotājam veikt uzdevumu ar faktiskajām vadīklām, priekšnoteikumiem un iznākumu. Tie papildina viens otru.
Dokumentācijas rīki parāda sadaļu definīcijas un jautājumus. Pārskatiet lietotnes atbalstītos uzdevumus, sniedziet trūkstošo kontekstu un sekojiet rakstīšanas gaitai.
Projekts publicē sava apjoma pieejamos lokalizētos ceļvežus. Pārskatiet katru publicēto valodu, lai tajā saglabātos pilna procedūra un pareizie saskarnes nosaukumi.
Pēc izmaiņām, kas ietekmē uzdevumu, tā vadīklas vai sagaidāmo rezultātu. Pārbaudiet tekstu pret strādājošo lietotni, nevis pieņemiet, ka sākotnējās instrukcijas joprojām ir spēkā.
Galapunkta atsauce pieder projektam ar aktīvu, strādājošu API. Izmantojiet tās aktīvās darbības un faktisko atsauci; ar plānotiem maršrutiem nepietiek, lai dokumentētu lietojamu integrāciju.