Tuotedokumentaatio
Auta käyttäjiä suorittamaan sovelluksesi tukemat tehtävät
Tarjoa käyttäjille käytännön oppaita, jotka selittävät sovelluksen polut ja auttavat heitä suorittamaan tehtävänsä.
Muuta tuotteen toiminnot käytännön ohjeiksi
- Valmistele oppaan laajuus
Tarkista dokumentaation osiot ja niiden kohdeyleisö.
- Vastaa sisältöä koskeviin kysymyksiin
Selvennä, mitä työnkulkuja ja tietoja oppaan pitää selittää.
- Seuraa julkista palvelua
Tarkastele rakentamisen etenemistä ja dokumentaatiosivuston osoitetta.
Selitä, miten sovellusta käytetään
Dokumentaatio täydentää tuote-esittelyä käytännön ohjeilla. Aloita aloitusoppaalla ja ohjaa käyttäjät sitten niiden työnkulkujen läpi, joita sovellus todella tukee.
Dokumentaation määritys näyttää osioiden määritelmät ja kysymykset. Anna kontekstia, joka auttaa selittämään tehtävän käyttäjän kielellä.
Pidä opas yhteydessä toimivaan sovellukseen
Tue ensimmäistä hyödyllistä toimintoa. Aloitusopas tarjoaa uusille käyttäjille lyhyen polun tuotteeseen. Sen pitää kertoa, mistä aloittaa, mitä tietoja tarvitaan ja mikä tulos vahvistaa tehtävän valmistuneen.
Selitä toistuva työnkulku. Yksityiskohtainen opas noudattaa sovelluksen todellisia nimiä ja toimintoja. Edellytykset, numeroidut vaiheet ja odotettu tulos auttavat toistamaan liiketoimintatehtävän ilman, että näkymän yleistä kuvausta tarvitsee tulkita.
Vastaa monia alueita koskevaan kysymykseen. Jotkin kysymykset koskevat tilejä, kustannuksia tai julkaisemista eivätkä yhtä näkymää. UKK antaa tiiviin vastauksen ja linkittää asiaan liittyvään oppaaseen, jolloin menettely pysyy yhdessä paikassa eikä toistu ympäri sivustoa.
Pidä oppaat yhteydessä tuotteeseen
Tarkista dokumentaatio sovelluksen merkittävän muutoksen jälkeen. Oppaan pitää käyttää nimiä ja toimintaa, jotka käyttäjät todella näkevät.
Dokumentaatio toimii omassa julkisessa palvelussaan. Linkitä siihen verkkosivustolta ja tarkista oppaat kielillä, joilla projektisi julkaisee.
Auta käyttäjää suorittamaan seuraava tehtävä
Käytännön opas kertoo, mistä aloittaa, mitä tietoja tarvitaan ja miten tulos tarkistetaan. Sen arvo on siinä, että se auttaa lukijaa toimimaan sovelluksessa.
Jatka polkua aiheeseen liittyvien oppaiden avulla, kun tehtävä ulottuu useille alueille. Tarkista dokumentaatio, kun näkymä muuttuu, jotta ohjeet pysyvät hyödyllisinä muutoksen jälkeen.
Sovituista toiminnoista hyödylliseen ohjeeseen
Valmistele oppaan laajuus. Tarkista dokumentaation osiot ja tehtävät, jotka niiden pitää selittää. Pidä kohdekäyttäjä ja sovelluksen toiminta selkeinä.
Anna puuttuva konteksti. Vastaa edellytyksiä, sääntöjä ja lopputuloksia koskeviin kysymyksiin. Tekstin pitää käyttää todellista käyttöliittymää eikä keksittyjä säätimiä.
Tarkista julkaisun ja muutoksen jälkeen. Seuraa opasta sovelluksessa, tarkista sen kielet ja aiheeseen liittyvät linkit ja palaa siihen, kun taustalla oleva tehtävä muuttuu.
Tee tuotteesta helpompi käyttää ensimmäisen käynnin jälkeen
Tarjoa tulokseen johtavat ohjeet sovelluksen toiminnan julkisen esittelyn rinnalla.
Kysymyksiä tuotedokumentaatiosta
Ominaisuussivu auttaa mahdollista asiakasta ymmärtämään ominaisuuden ja sen arvon. Opas auttaa käyttäjää suorittamaan tehtävän todellisten säätimien, edellytysten ja lopputuloksen avulla. Ne täydentävät toisiaan.
Dokumentaation työkalut näyttävät osioiden määritelmät ja kysymykset. Tarkista sovelluksen tukemat tehtävät, anna puuttuva konteksti ja seuraa kirjoittamisen etenemistä.
Projekti julkaisee laajuuteensa sisältyvät lokalisoidut oppaat. Tarkista jokainen julkaistu kieli, jotta koko menettely ja käyttöliittymän oikeat nimet säilyvät.
Muutoksen jälkeen, joka vaikuttaa tehtävään, sen säätimiin tai odotettuun tulokseen. Vertaa tekstiä toimivaan sovellukseen sen sijaan, että olettaisit alkuperäisten ohjeiden pätevän edelleen.
Päätepisteiden viitedokumentaatio kuuluu projektille, jolla on aktiivinen ja toimiva API. Käytä sen toiminnassa olevia operaatioita ja todellista viitettä; suunnitellut reitit eivät riitä käyttökelpoisen integraation dokumentointiin.