Käyttöopas vuorovaikutteiseksi ohjeeksi: valitse tarkistettava ensimmäinen tehtävä
Päätä tämän auditoinnin avulla, mikä käyttöoppaan sisältö sopii ensimmäiseksi vuorovaikutteiseksi tehtäväksi ja mitä valmistelua vielä tarvitaan. Kirjaa lähde, asiakkaan kysymys, visuaalinen tarve ja tarkistuksesta vastaava henkilö ennen kuin valitset oppaan, selkeämmän artikkelin tai lähteen päivityksen.
Nimeä tehtävä ja toistuva kysymysVarmista soveltuva lähdeEsimerkki: viiteluku ei ole ensimmäinen opas
Ongelma
Mitä tämän työnkulun avulla voit valmistella
Päätä tämän auditoinnin avulla, mikä käyttöoppaan sisältö sopii ensimmäiseksi vuorovaikutteiseksi tehtäväksi ja mitä valmistelua vielä tarvitaan. Kirjaa lähde, asiakkaan kysymys, visuaalinen tarve ja tarkistuksesta vastaava henkilö ennen kuin valitset oppaan, selkeämmän artikkelin tai lähteen päivityksen.
Pidä pyyntö tai tehtävä arvioitavana kirjaamalla tuote ja versio, käyttöoppaan kohta, toistuva kysymys, visuaalinen ratkaisu, lähteen puutteet ja tarkistuksesta vastaava henkilö. Kirjaa vahvistetut ja tuntemattomat tiedot erikseen ja varmista seuraava hyväksytty vaihe soveltuvasta tuotelähteestä.
Kuvaile yksi mahdollinen tehtävä. Lomake luo suunnitteluyhteenvedon antamistasi tiedoista; se ei analysoi eikä lataa PDF-tiedostoa palveluun.
Käytännön ohjeet
Suorita tehtävä oikeiden taustatietojen avulla.
Nimeä tehtävä ja toistuva kysymys
Valitse yksi toiminto tai päätös, jonka kanssa käyttäjillä on toistuvasti vaikeuksia. Kirjaa valinnan taustalla olevat havainnot, kuten tukikysymys tai nähty kokoonpanovirhe. Pelkästään useita käyttöoppaan sivuja vievä aihe ei välttämättä ole hyödyllisin ensimmäinen opas.
Tuote ja versio
Käyttöoppaan kohta
Toistuva kysymys
Varmista soveltuva lähde
Kirjaa tuote, käyttöoppaan versio ja olennainen kohta. Ilmoita puuttuvat edellytykset, epäselvät arvot ja ristiriitaiset osaviitteet. Nämä ovat lähteen tarkistettavia puutteita, eivät syitä antaa automaattisen sisällöntuotannon keksiä koko menettelyä.
Visuaalinen ratkaisu
Lähteen puutteet
Tarkistuksesta vastaava
Kuvaa, miksi visuaalinen esitys auttaa
Tunnista tekstistä vaikeasti hahmotettava päätös: suunta, piilossa oleva liitos, osan tunnistus tai olennainen liike. Nimetty kaavio voi riittää tiedonhakuun. Käytä 3D-näkymää tai animaatiota, kun valittu tehtävä sitä todella tarvitsee.
Valmistele tarkistettava tulos
Työkalu kokoaa tehtävän, lähteen, visuaalisen tarpeen ja vastuuhenkilön kopioitavaksi auditointiyhteenvedoksi. Se ei lue käyttöopasta eikä poimi siitä vaiheita automaattisesti. Käy yhteenveto läpi asiantuntijan kanssa ja päätä, mitä sisältöä ja aineistoja pitää valmistella.
Esimerkki: viiteluku ei ole ensimmäinen opas
Esimerkkiauditoinnissa yksityiskohtainen teknisten tietojen luku säilyy linkitettynä viitemateriaalina, kun taas toistuva kysymys paneelin suunnasta valitaan ensimmäiseksi opasaiheeksi. Tehtävällä on soveltuva lähde ja havaittava lopputulos. Näin molemmat sisältömuodot pysyvät hyödyllisinä ilman, että koko PDF pakotetaan vaihelistaksi.
Määritä seuraava toimi selkeästi
Päätä, pitääkö lähde selventää, kuva valmistella, luonnos tarkistaa vai artikkelimuoto säilyttää. Nimeä pilotille vastuuhenkilö ja hyväksymiskysymys. Sisällön priorisointi käytännön seuraavan toimen mukaan on hyödyllisempää kuin kaikkien käyttöoppaan osien julistaminen muunnosvalmiiksi.
Seuraavaan kirjaukseen sopivat tiedot
Laadi käyttöoppaan auditointia varten kirjaus, joka valitsee tarkistettavan ensimmäisen tehtävän ja yhdistää lähteen varsinaiseen työhön. Kopioi alla olevat taustatiedot omaan tuote-, tuki- tai tarkistusprosessiin. Lisää soveltuvan lähteen viite ja vastuuhenkilö, jotta seuraava tiimi näkee, mitä pitää vielä vahvistaa.
Tuote ja versio
Käyttöoppaan kohta
Toistuva kysymys
Visuaalinen ratkaisu
Lähteen puutteet
Tarkistuksesta vastaava
Työnkulku
Käytä työkalua ja tarkista tulos
01
Määritä lähtötilanne
Kirjaa tuote ja versio, käyttöoppaan kohta sekä toistuva kysymys ja tunnista soveltuva lähde.
02
Tarkastele yhtä tehtävää
Käytä esimerkkiä, jossa viiteluku ei ole ensimmäinen opas, rajauksen keskusteluun. Tarkista sitten varsinainen tehtävä ja avoimet tiedot siitä vastaavan henkilön kanssa.
03
Varmista seuraava luovutus
Liitä kirjaukseen visuaalinen ratkaisu, lähteen puutteet, tarkistuksesta vastaava henkilö ja avoin kysymys.
Usein kysytyt kysymykset
Tätä tehtävää koskevia kysymyksiä.
Jäsentääkö auditointi PDF:n automaattisesti?
Ei. Se laatii suunnitteluyhteenvedon antamistasi tiedoista. Varsinainen lähteen poiminta, visuaalisen aineiston valmistelu ja tuoteomistajan tarkistus ovat erillisiä tehtäviä.
Mitä tietoja kirjaukseen kannattaa sisällyttää?
Kirjaa tuote ja versio, käyttöoppaan kohta, toistuva kysymys, visuaalinen ratkaisu, lähteen puutteet ja tarkistuksesta vastaava henkilö. Erota vahvistetut tunnisteet, havainnot ja avoimet kysymykset, jotta seuraava vastuuhenkilö voi valita soveltuvan lähteen.
Miten tuntematon tuotetieto tulee käsitellä?
Merkitse puuttuva tieto tuntemattomaksi ja pidä sen tarkistamisesta vastaava henkilö näkyvissä. Käytä saatavilla olevaa lähdettä ja tietueita taustan selvittämiseen ennen tuotekohtaisen vastauksen antamista.
Miten Viflux voi auttaa tässä työnkulussa?
Tuo esiin yksi tuote ja hyväksytty lähde toistuvalle kysymykselle. Kohdennetussa demossa voidaan näyttää, miten nimetyt kuvat, tarkistetut vaiheet tai selkeämpi tukikirjaus auttavat tuotteen ja käyttöoppaan kohdan yhteydessä. Sopikaa valmistelusta ja tarkistuksesta ennen laajentamista.
Aiheeseen liittyvät sivut
Aiheeseen liittyviä oppaita ja hyödyllisiä työkaluja.
Aloita yhdestä tuotteesta ja toistuvasta kysymyksestä
Lähetä hyväksytty käyttöopas, kaaviot tai valokuvat, jotka sinulla jo on. Pyydä maksuton opasdemo, jotta tiimisi voi tarkastella yhtä tuotetehtävää ennen laajentamisesta päättämistä.
Yksi tuote ja soveltuva versioNykyinen hyväksytty dokumentaatioYksi tehtävä tai toistuva tukikysymys