Kuidas käsitleda värskendusi ja muudatusi kasutusjuhendites
VÄRSKENDUSED JA PARANDUSED
Kasutusjuhendite sisu õigeks ja kasutajate jaoks ajakohaseks hoidmiseks on ülioluline muudatuste ja muudatustega tegelemine. Värskenduste ja muudatuste haldamisel peaksite tegema järgmised täpsed toimingud.
- Redaktsioonide poliitika loomine:
Luua selge ja ühtne lähenemisviis selle kohta, millal ja kuidas kasutusjuhendite värskendusi ja muudatusi tehakse. Selles poliitikas tuleks välja tuua kriteeriumid, mille alusel hinnatakse, millal uuendusi on vaja, ja muudatuste tegemise kord. - Tehke rutiinseid hindamisi:
Kavandage oma kasutusjuhendite sagedasi hindamisi, et teada saada, mis vajab värskendamist või muutmist. Seda saab teha igal aastal või siis, kui dokumenteeritavas tootes või teenuses tehti olulisi muudatusi. Mõelge tehniliste kirjanike, teemaekspertide ja muude oluliste sidusrühmade kaasamiseleview menetlust. - Tagasiside saamine:
Otsige aktiivselt kasutajate, klienditoe meeskonna ja muude allikate tagasisidet, et määrata kindlaks käsitsi jaotised, mis võivad vajada täiustamist, laiendamist või läbivaatamist. Kasutajate arvamused võivad pakkuda olulist teavet kohtadest, kus praegune versioon võib olla ebaselge või puudulik. - Dokumendi muudatused:
Pidage põhjalikku arvestust iga tehtud muudatuse kohta kogu värskendamise ja läbivaatamise protsessi jooksul. Konkreetseid tehtud muudatusi, täiendusi ja eemaldamisi tuleks selles dokumentatsioonis kirjeldada koos iga kohanduse põhjendustega. See on viide tulevastele täiustustele ja aitab säilitada läbipaistvat kontrolljälge. - Versioonihaldus:
Igale kasutusjuhendi iteratsioonile tuleks anda spetsiaalne versiooninumber või kood. See tagab, et kasutajad tunnevad oma versiooni hõlpsalt ära ja võimaldavad konkreetsetele versioonidele viidates selget suhtlust. - Kasutage märgistuse ja jälgimise muudatusi:
Kasutage tekstitöötlusprogrammi muudatuste jälgimise või märgistustööriistu, et esile tõsta tehtud muudatusi nende tegemise ajal. See suurendab läbipaistvust kogu läbivaatamisprotsessis ning muudab selle toimetajate ja redaktsioonide jaoks lihtsamaksviewmuutusi märgata. - Hoidke värskendatud redaktsioonide ajalugu:
Esitage kasutajatele igas versioonis tehtud muudatuste kokkuvõte, lisades kasutusjuhendisse jaotise versioonide ajaloo kohta. Lisage värskenduste või versioonide loend, versiooni number või kood ja väljalaske kuupäev. - Ristviited ja uuendatud sisukord:
Kontrollige juhendi registrit, sisukorda ja kõiki ristviiteid, et veenduda, et need kajastavad täpselt muudetud materjali. Järjepidevuse huvides värskendage vastavalt vajadusele lehtede viiteid ja numbreid. - Teavitage kasutajaid uuendustest:
Kõik kohandused või muudatused tuleb kasutajatele selgeks teha. Seda saab teha kaudu websaiditeated, meiliteatised või muud kanalid, mida teie kasutajad sageli kasutavad. Kirjeldage, kuidas hankida uusim versioon, ja loetlege kõik olulised uuendused või tehtud muudatused. - Eelmiste versioonide arhiiv:
Kasutusjuhendi varasemate iteratsioonide kohta tuleks säilitada füüsiline või digitaalne arhiiv. See tagab põhjaliku ajaloolise ülevaate dokumendi arengust ja võimaldab vajadusel viidata varasematele versioonidele.
UUENDUSTE JA PARANDUSTE KÄSITLEMINE KASUTUSJUHENDITES
Tagamaks, et kasutajatel on juurdepääs õigele ja ajakohasele teabele, peavad kasutusjuhendid käsitlema muudatusi ja parandusi. Kasutusjuhendite muudatuste ja muudatuste tõhusaks haldamiseks järgige neid nõuandeid.
- Üksikasjalik dokumentatsioon:
Pidage iga värskenduse või versiooni jaoks tehtud muudatuste kohta igakülgset arvestust. Jälgige juhendis tehtud konkreetseid muudatusi, täiendusi ja kustutamisi. Seda dokumentatsiooni kasutatakse tulevaste versiooniuuenduste juhendina ja muudatuste selgitamiseks kasutajatele. - Revisjonide ajalugu:
Lisage juhendi algusesse või lõppu jaotis redaktsioonide ajaloo kohta. Loetlege iga versiooni versiooninumber või kood, väljalaskekuupäev ja selles tehtud muudatuste lühikokkuvõte. Kasutajad saavad kontrollida, mida on värskendatud, ja määrata, milline versioon neil tänu sellele on. - Viimati värskendatud:
Veenduge, et käsiraamatu esilehel või alguses oleks nähtaval kohal viimase värskenduse kuupäev. See võimaldab klientidel kindlaks teha, kas nad kasutavad uusimat versiooni või on vaja kiiresti uuendada. - Lihtsad värskendamise juhised:
Andke täpsed juhised selle kohta, kuidas hankida kasutaja käsiraamatu uusim väljaanne, kui seda on vaja värskendada. See võib hõlmata kasutajate suunamist teatud suunas websaidi, e-posti aadressi või klienditeeninduse kontaktandmed. - Leheküljenumbrid ja ristviited:
Käsiraamatus olevaid ristviiteid tuleks pärast muudatuste tegemist kontrollida, et veenduda nende kehtivuses. Värskendage sisukorda, registrit ja muid asjakohaseid viiteid, kui on muudatusi, mis mõjutavad lehekülgede nummerdamist. - Kasutage märgistust või jälgi muudatusi:
Kui redaktsiooni kallal töötab mitu inimest, saab muudatuste jälgimiseks kasutada tekstitöötlustarkvara muudatuste jälgimist või märgistustööriistu. See muudab selle toimetajate ja muude jaoks lihtsaksviewleida ja uurida dokumendis tehtud muudatusi. - Kasutaja Reviews:
Julgustage kasutajaid kommenteerima käsiraamatu sisu, loetavust ja probleeme, mida nad näevad. Kasutajate arvamusi saab kasutada täiustamist vajavate valdkondade täpsustamiseks ja tulevaste värskenduste suunamiseks. - Värskendage kasutajaid uue sisuga:
Kaaluge teatise saatmist kasutajatele, kes on käsiraamatu juba alla laadinud või kätte saanud, kui seda tehakse olulise värskenduse või muudatuse korral. Saate seda teha, saates meili, uudiskirja või websaidi teatis.
DOKUMENTIDE HALDUSSÜSTEEM
Rakendada dokumendihaldussüsteem, mis jälgib levitamist, review, ja teisedtagkasutusea pikkus. See aitab säilitada järjepidevat ja organiseeritud lähenemist värskendustele ning tagab, et õige versioon on õigetele inimestele kättesaadav.
Versioonihaldus:
Andke kasutusjuhendi iga uue väljalase jaoks spetsiaalne versiooninumber või kood. See muudab aja jooksul toimuvate muutuste jälgimise lihtsamaks ja tagab, et viited konkreetsetele versioonidele on selged.
Ülesanded versioonihalduses:
- Pessimistlik versioonikontroll, mida mõnikord nimetatakse lukustamiseks, muutke juurdepääsu a file on piiratud, kui selle kallal juba töötab mõni teine töötaja. Seda nimetatakse kirjutamiseks või eksklusiivseks väljaregistreerimiseks. See kaotab nõude kombineerida mitu värskendust. Redigeerida saab mitu kasutajat files samaaegselt optimistliku versioonihaldusega, mida nimetatakse ka koopia muutmise ühendamiseks, kuid muudatused tuleb ühendada käsitsi või automaatselt.
- Dokumentidega tegelevad protsessimudelid, nagu V-Modell XT või Hermes, kasutavad ka muudatuste indekseid, et anda dokumentide lugejatele tabeliversiooni ajalugu. See võimaldab lugejal eristada selliseid asju, nagu millised versioonid millal avaldati, kes olid kirjutajad ja vajaduse korral, kas versioonierinevused on selgelt märgitud. Ta ei pruugi siiski tuvastada, kas ta loeb dokumendi uusimat ja kõige ajakohasemat versiooni.
Versioonihalduse kontseptsioonid
- Individuaalne file olekuid saab arhiveerida nii, et a file on alati juurdepääsetav, kuid vajadusel pääseb juurde ka vanematele versioonidele, mis toimivad omamoodi varusalvestuse modifikatsioonina, et oleks võimalik tuvastada, kes milliseid muudatusi tegi. file.
- Juurdepääsu koordineerimine a file ja mis tahes kohaldatavate lugemis-, kirjutamis- ja kustutamisõiguste määratlemine.
- Mõned süsteemid annavad kasutajatele lisaks võimaluse kuvada või peita files vastavalt etteantud õigustele.