A dokumentációs csapatok a jóváhagyott termékismeretekből útmutatókat készíthetnek azokhoz a helyzetekhez, amikor a felhasználóknak cselekedniük kell. Egy hasznos első projekt egy visszatérő kérdést kapcsol össze megbízható forrással, az érintett termékkel és a gyakorlatban ellenőrizhető feladattal.
Keressen egy feladatot a dokumentumtárbanTegye láthatóvá a forrásért viselt felelősségetTegye követhetővé a csatornák közötti újrafelhasználást
Probléma
Mit segít előkészíteni ez a munkafolyamat?
A dokumentációs csapatok a jóváhagyott termékismeretekből útmutatókat készíthetnek azokhoz a helyzetekhez, amikor a felhasználóknak cselekedniük kell. Egy hasznos első projekt egy visszatérő kérdést kapcsol össze megbízható forrással, az érintett termékkel és a gyakorlatban ellenőrizhető feladattal.
A következő kontextussal tegye ellenőrizhetővé a kérést vagy feladatot: visszatérő kérdés, érintett termék, jóváhagyott forrás, terminológiai megfeleltetés, ellenőrzési felelős és változtatási folyamat. Rögzítse az ellenőrzött és még ismeretlen adatokat, majd a termékre alkalmazható forrás alapján határozza meg a következő jóváhagyott lépést.
Gyakorlati útmutatás
Végezze el a feladatot a megfelelő háttérinformációkkal.
Keressen egy feladatot a dokumentumtárban
Tekintse át az ügyféltámogatási kérdéseket, és keresse az egy alkatrészhez, kezelőszervhez vagy lépéshez kapcsolódó visszatérő bizonytalanságokat. Keresse meg a jóváhagyott választ, és határozza meg, mely termékekre érvényes. Ezzel a körülhatárolt feladattal kezdjen az összes kézikönyv újraépítése vagy a pusztán magas oldalletöltés alapján kiválasztott tartalom helyett.
Visszatérő kérdés
Érintett termék
Jóváhagyott forrás
Tegye láthatóvá a forrásért viselt felelősséget
Rögzítse a kézikönyv vagy cikk verzióját, a szakmai felelőst és az ellenőrzés állapotát. Az útmutató származtatott tartalom, amelynek változásai ugyanolyan figyelmet igényelnek, mint a forrásé. Közzététel előtt döntse el, hogyan jut el egy frissítés a szemléltetéshez, a feladatszöveghez és az asszisztens tudásához.
Terminológiai megfeleltetés
Ellenőrzési felelős
Változtatási folyamat
Ellenőrizze a kinyert vázlatokat a forráshoz képest
Az MI segíthet a szöveg és a lehetséges lépések rendszerezésében, de a szövegíró és a termékfelelős ellenőrzi a megfeleltetést. Az egyértelműtlen ábrahivatkozásokat, a hiányzó feltételeket és a következetlen terminológiát tartsa ellenőrzési listán. Egy gördülékeny vázlat ne fedjen el olyan forráshiányt, amelyhez még mérnöki közreműködés szükséges.
Példa: az ügyféltámogatás más alkatrésznevet használ
Szemléltető szerkesztési eset: az ügyfelek egy szerelvényt tartónak neveznek, miközben a kézikönyv katalógusban szereplő kifejezést használ. Az útmutató mindkét kifejezést a jóváhagyott megnevezéshez és az ábrán látható helyhez kapcsolja. A hivatalos alkatrészhivatkozás változatlan marad, így a magyarázat érthetővé válik az alkatrészek azonosságának megváltoztatása nélkül.
Tegye követhetővé a csatornák közötti újrafelhasználást
Használja ugyanazt a jóváhagyott feladatot termékoldalról, támogatási cikkből vagy QR-belépési pontból, ahol ez indokolt. Ellenőrizze, hogy minden belépési pont megadja a modellt és a verziót. Az újrafelhasználás az ellentmondó magyarázatokat csökkentse, ne egy ellenőrizetlen választ másoljon több oldalra.
Mérje fel az útmutató után is nyitva maradó kérdéseket
Termékfeladatonként rögzítse a forráseltéréseket, az ismétlődő pontosításokat és a megválaszolatlan kérdéseket. Vizsgálja meg ezeket a jeleket a dokumentáció felelősével. Bizonyítékok alapján adjon elsőbbséget egy világosabb szemléltetésnek vagy egy hiányzó forrásrésznek, és hasonló feladatokat hasonlítson össze, mielőtt a támogatási igény változását az útmutatónak tulajdonítja.
Újrahasználható mezők a következő adatlaphoz
Készítsen olyan nyilvántartási bejegyzést a dokumentációs csapatok interaktív termékútmutatóihoz, amely összeköti a forrást a tényleges feladattal. Másolja az alábbi kontextusmezőket saját termék-, támogatási vagy ellenőrzési folyamatába. Adja hozzá az alkalmazható forráshivatkozást és a felelőst, hogy a következő csapat lássa, mi vár még megerősítésre.
Visszatérő kérdés
Érintett termék
Jóváhagyott forrás
Terminológiai megfeleltetés
Ellenőrzési felelős
Változtatási folyamat
Munkafolyamat
Készítsen elő egy első ellenőrzött munkafolyamatot
01
Állapítsa meg a kontextust
Rögzítse a visszatérő kérdést, az érintett terméket és a jóváhagyott forrást, és azonosítsa az alkalmazható forrást.
02
Vizsgáljon meg egy feladatot
A csatornák közötti újrafelhasználás követhetőségéről szóló forgatókönyv segítségével beszéljék meg a hatókört, majd a felelőssel ellenőrizzék a tényleges feladatot és a hiányzó mezőket.
03
Ellenőrizze a következő átadást
Őrizze meg a terminológiai megfeleltetést, az ellenőrzési felelőst, a változtatási folyamatot és a megoldatlan kérdést a létrejövő bejegyzésben.
Gyakori kérdések
Kérdések erről a feladatról.
Mi lehet megfelelő első útmutató egy műszaki szövegírói csapat számára?
Válasszon egy visszatérő termékkérdést jóváhagyott forrással és egyértelmű feladateredménnyel. Egy zavaros tájolást vagy alkatrészhivatkozást gyakran könnyebb ellenőrizni, mint egy teljes termékkézikönyv átállítását.
Milyen mezőket tartalmazzon az adatlap?
Használja a visszatérő kérdést, az érintett terméket, a jóváhagyott forrást, a terminológiai megfeleltetést, az ellenőrzési felelőst és a változtatási folyamatot. Különítse el az ellenőrzött azonosítókat, a megfigyeléseket és a megoldatlan kérdéseket, hogy a következő felelős kiválaszthassa az alkalmazható forrást.
Hogyan kell kezelni egy ismeretlen termékrészletet?
Jelölje ismeretlenként a hiányzó részletet, és tegye láthatóvá az ellenőrzéséért felelős személyt. A rendelkezésre álló visszatérő kérdés és forrásadatok alapján állapítsa meg a kontextust, mielőtt termékspecifikus választ ad.
Hogyan segíthet a Viflux ebben a munkafolyamatban?
Hozzon egy terméket és egy visszatérő kérdéshez tartozó jóváhagyott forrást. Egy célzott bemutató megmutathatja, hogyan segítenek a feliratozott ábrák, az ellenőrzött lépések vagy egy egyértelműbb támogatási bejegyzés a visszatérő kérdés és az érintett termék esetében. Az élmény bővítése előtt egyezzenek meg az előkészítésről és az ellenőrzésről.
Küldje el a már rendelkezésre álló jóváhagyott kézikönyvet, ábrákat vagy fényképeket. Kérjen ingyenes útmutató-demót, hogy csapata értékelhessen egy termékfeladatot, mielőtt a bővítésről dönt.
Egy termék és az alkalmazandó verzióMeglévő jóváhagyott dokumentációEgy feladat vagy visszatérő támogatási kérdés