Kiel Pritrakti Ĝisdatigojn kaj Reviziojn en Uzantmanlibroj
Ĝisdatigoj kaj revizioj
Por konservi la enhavon en uzantmanlibroj ĝusta kaj aktuala por uzantoj, estas grave trakti ŝanĝojn kaj modifojn. Kiam vi administras ĝisdatigojn kaj modifojn, vi devas fari la jenajn precizajn agojn:
- Krei Politikon por Revizioj:
Establi klaran kaj unuforman aliron por kiam kaj kiel uzantmanaj ĝisdatigoj kaj amendoj estos produktitaj. La kriterioj por taksi kiam ĝisdatigoj estas postulataj kaj la proceduro por fari alĝustigojn devus esti skizitaj en ĉi tiu politiko. - Faru rutinajn taksojn:
Planu oftajn taksojn de viaj uzantmanlibroj por ekscii, kio bezonas ĝisdatigon aŭ ŝanĝiĝon. Ĉi tio povas esti farita ĉiujare aŭ kiam ajn la produkto aŭ servo dokumentita spertis grandan ŝanĝon. Pensu pri inkluzivi teknikajn verkistojn, temajn fakulojn kaj aliajn gravajn koncernatojn en la review procedo. - Akiro de sugestoj:
Aktive serĉu uzanton, klientsubtenan teamon kaj aliajn fontojn por indiki manajn sekciojn, kiuj povus postuli pliprofundigon, vastiĝon aŭ revizion. Opinioj de uzantoj povus proponi gravajn sciojn pri lokoj kie la nuna versio povus esti neklara aŭ manka. - Dokumentaj Amendoj:
Konservu ĝisfundan registron de ĉiu modifo farita dum la procezo de ĝisdatigo kaj revizio. La apartaj ŝanĝoj, aldonoj kaj forigoj faritaj devus esti priskribitaj en ĉi tiu dokumentaro, kune kun la pravigoj por ĉiu alĝustigo. Ĉi tio servos kiel referenco por venontaj plibonigoj kaj helpos konservi travideblan kontrolon. - Administrado de Versio:
Ĉiu ripeto de la uzantmanlibro devus ricevi specialan versinumeron aŭ kodon. Ĉi tio certigas, ke uzantoj povas rekoni la version, kiun ili havas, kaj ebligas klaran komunikadon kiam ili rilatas al apartaj versioj. - Uzu Markadon kaj Monitorajn Ŝanĝojn:
Uzu la spurajn ŝanĝojn aŭ markadajn ilojn en via tekstprilabora programo por reliefigi ŝanĝojn, kiujn vi faris dum vi faras ilin. Ĉi tio antaŭenigas travideblecon dum la revizioprocezo kaj faciligas ĝin por redaktantoj kaj reviewers ekvidi ŝanĝojn. - Konservu ĝisdatigitan reviziohistorion:
Provizu al uzantoj resumon de la ŝanĝoj faritaj en ĉiu versio inkludante sekcion pri revizia historio en la uzantmanlibro. Inkluzivu liston de la ĝisdatigoj aŭ revizioj, la versinumeron aŭ kodon, kaj la eldondaton. - Kruc-referencoj kaj la ĝisdatigita enhavtabelo:
Kontrolu la indekson, enhavtabelon kaj ajnajn krucreferencojn en la manlibro por certigi, ke ili precize reprezentas la reviziitan materialon. Por konsistenco, ĝisdatigu paĝajn referencojn kaj nombrojn laŭbezone. - Informu Uzantojn pri Ĝisdatigoj:
Ĉiuj alĝustigoj aŭ revizioj devas esti klaraj al uzantoj. Ĉi tio povas esti farita per webretejo-anoncoj, retpoŝtaj sciigoj aŭ aliaj kanaloj, kiujn viaj uzantoj ofte uzas. Priskribu kiel akiri la plej freŝan version kaj listigu iujn ajn signifajn ĝisdatigojn aŭ ŝanĝojn faritajn. - Antaŭaj Versioj Arkivo:
Fizika aŭ cifereca arkivo de pasintaj ripetoj de la uzantmanlibro devus esti konservita. Ĉi tio garantias ĝisfundan historian registron de la evoluo de la dokumento kaj ebligas vin referenci al pli fruaj versioj se necese.
Pritraktu ĝisdatigojn kaj reviziojn en UZANTMANlibroj
Por garantii ke uzantoj havas aliron al ĝustaj kaj aktualaj informoj, uzantgvidiloj devas trakti ŝanĝojn kaj reviziojn. Por administri ŝanĝojn kaj modifojn en uzantmanlibroj efike, sekvu ĉi tiujn konsiletojn:
- Detala dokumentado:
Konservu ĝisfundan registron pri la ĝustigoj faritaj por ĉiu ĝisdatigo aŭ revizio. Konservu la apartajn ŝanĝojn, aldonojn kaj forigojn, kiujn vi faris al la manlibro. Ĉi tiu dokumentaro estos uzata kiel gvidilo por venontaj ĝisdatigoj kaj por klarigi la ŝanĝojn al uzantoj. - Historio de revizioj:
Aldonu sekcion pri reviziohistorio ĉe la komenco aŭ konkludo de la manlibro. Listigu la version-numeron aŭ kodon de ĉiu revizio, eldondaton, kaj mallongan resumon de la ŝanĝoj faritaj en ĝi. Uzantoj povas kontroli kio estis ĝisdatigita kaj determini kiun version ili havas danke al tio. - Plej Ĝisdatigita Je:
Sur la kovrilpaĝo aŭ ĉe la komenco de la manlibro, certigu, ke vi elstare inkluzivas la daton de la plej lastatempa ĝisdatigo. Ĉi tio ebligas al klientoj konstati ĉu ili funkcias la plej lastatempan version aŭ ĉu ĝisdatigo estas necesa rapide. - Simplaj Ĝisdatigaj Instrukcioj:
Donu precizajn instrukciojn pri kiel akiri la plej lastatempan eldonon de uzantmanlibro se oni devas esti ĝisdatigita. Ĉi tio povas implici indiki uzantojn direkte al iu webretejo, retpoŝtadreso aŭ kontaktaj detaloj de klientservado. - Paĝnumeroj kaj krucreferencoj:
Kruc-referencoj en la manlibro devas esti kontrolitaj post modifoj por certigi, ke ili ankoraŭ validas. Ĝisdatigu la enhavtabelon, indekson, kaj ajnajn aliajn trafajn referencojn se estas iuj ŝanĝoj kiuj efikas sur la paĝnumerado. - Uzu Markadon aŭ Spuri Ŝanĝojn:
Kiam pluraj personoj laboras pri revizio, la trakŝanĝoj aŭ markadaj iloj de tekstprilaborado povas esti uzataj por konservi trakon de ŝanĝoj. Ĉi tio simpligas ĝin por redaktantoj kaj reviewers trovi kaj ekzameni ajnajn modifojn kiuj estis faritaj al la dokumento. - Uzanto Reviews:
Instigu uzantojn komenti la enhavon, legeblecon kaj ajnajn problemojn, kiujn ili vidas en la manlibro. Uzant-opinioj povas esti uzataj por indiki areojn kiuj volas plibonigon kaj gvidi estontajn ĝisdatigojn. - Ĝisdatigu uzantojn pri nova enhavo:
Konsideru sendi sciigon al uzantoj, kiuj jam elŝutis aŭ ricevis la manlibron, kiam ajn granda ĝisdatigo aŭ revizio estas farita. Vi povas fari tion sendante retpoŝton, bultenon aŭ webreteja sciigo.
DOKUMENTA ADMINISTRO-SISTEMO
Efektivigi dokumentan mastruman sistemon, kiu kontrolas la distribuadon, review, kaj aliajtages de la vivdaŭro de la uzantmanlibro. Ĉi tio helpas konservi konsekvencan kaj fakorganizitan aliron al ĝisdatigoj kaj garantias, ke la ĝusta versio estas alirebla por la ĝustaj homoj.
Administrado de Versio:
Por ĉiu nova eldono de uzantmanlibro, donu al ĝi specialan version-numeron aŭ kodon. Ĉi tio faciligas konservi trakon de ŝanĝoj laŭlonge de la tempo kaj certigas, ke referencoj al apartaj versioj estas klaraj.
Taskoj en Versia Administrado:
- Pesimisma versiokontrolo, foje referita kiel Ŝlosu Modifi Aliron al a file estas limigita se alia dungito jam laboras pri ĝi. Ĉi tio estas konata kiel skribo aŭ ekskluziva checkout. Ĉi tio forigas la postulon kombini plurajn ĝisdatigojn. Multoblaj uzantoj povas redakti files samtempe kun optimisma versio-administrado, ankaŭ konata kiel kopio modifi kunfandi, tamen, la ŝanĝoj devas esti kunfanditaj permane aŭ aŭtomate.
- Procezaj modeloj, kiuj traktas dokumentojn, kiel V-Modell XT aŭ Hermes, ankaŭ uzas ŝanĝajn indeksojn por doni al legantoj de dokumentoj tabelan version-historion. Tio ebligas al la leganto distingi aferojn kiel kiuj versioj estis publikigitaj kiam, kiuj estis la verkistoj, kaj, se necese, ĉu versiodiferencoj estis eksplicite notitaj. Li eble ne povos identigi ĉu li tamen legas la plej freŝan, plej ĝisdatigitan version de la dokumento.
Konceptoj en Versia Administrado
- Individuo file ŝtatoj povas esti arkivitaj tiel ke la plej lastatempa versio de a file estas ĉiam alirebla, sed pli malnovaj versioj ankaŭ estas alireblaj se necese, agante kiel speco de rezerva registra modifo tiel ke estas eble identigi kiu faris kiajn ŝanĝojn al file.
- Kunordiga aliro al a file kaj difinante ajnajn legi, skribi kaj forigi rajtojn kiuj povas esti aplikeblaj.
- Iuj sistemoj aldone donas al uzantoj la elekton montri aŭ kaŝi files konforme al antaŭdestinitaj rajtoj.