Luând subiectul de soluționare a problemelor DITA pentru o rotire - Scriptorium
Această postare de invitat este de Carlos Evia, dr., Directorul de scriere profesională și tehnică la Virginia Tech.
Subiectul DITA Troubleshooting este una dintre caracteristicile „noi” din versiunea 1.3 a standardului. Cu toate acestea, depanarea a fost în jurul lumii DITA de câțiva opt ani buni acum.
O arhivă SourceForge de plug-in-uri pentru DITA Open Toolkit găzduiește încă o specializare în depanare lansată în octombrie 2007. Subiectul de depanare din 2007 suna ca o vizită la medic, cu etichete precum tsSymptoms, tsCauses, tsDiagnose și tsResolve (tsTake2Aspirins a fost prea lung, Cred).
Abia în iulie 2014, Comitetul tehnic pentru adoptarea DITA a anunțat subiectul de depanare ca un tip de conținut formal nou în standard. Comitetul a lansat apoi versiunea finală a cărții albe folosind DITA 1.3 Troubleshooting, scrisă de Bob Thomas. Cartea albă prezintă rațiunea subiectului de depanare și oferă exemple și șabloane detaliate, precise, concentrându-se pe o structură de perechi de informații cauză-remediu pentru a completa subiectul.
În acea perioadă, am fost invitat să conduc un proiect de consultanță pentru un client care are nevoie de un manual online pentru procesele legate de fabricarea cartonului (nu afacerea lor reală; doar un exemplu pentru acest post). Clientul a dorit să aibă informații „cum să” bazate pe web pentru operatorii responsabili cu procesele de carton ondulat și tăiat sub presiune (nu procesele reale pe care le-am documentat). În timp ce am reunit o echipă de profesori și studenți în comunicare tehnică și informatică, în timpul unei întâlniri timpurii, clientul a dezvăluit că manualul trebuie să se concentreze asupra depanării. Asta mi-a zgâriat mâncărimea pentru că am luat subiectul de depanare.
La șapte luni de la proces, pe măsură ce încheiem proiectul, aici împărtășesc câteva lecții învățate din experiența mea cu tema de depanare.
Efectuați o analiză a cauzei principale
Analiza sarcinilor, colectarea și analiza documentației vechi și interviuri. Aceste arme tradiționale pentru comunicarea tehnică nu sunt probabil eficiente pentru a obține informații de depanare. Când a căutat perechi cauză-remediu, echipa (condusă de personalul resurselor umane al clientului) a efectuat o analiză a cauzei radicale. În cea de-a 3-a ediție a cărții Root Cause Analysis, Latino & Latino a definit-o prin includerea a patru definiții diferite! Pentru cea de-a 4-a ediție (care include un al 3-lea latino în lista de co-autori), acestea simplifică definiția analizei cauzei radiculare ca „stabilirea stabilirii unor lanțuri de factori logice complete, bazate pe dovezi, strâns cuplate, de la cele mai puțin acceptabile consecințe până la cele mai profunde cauze semnificative care stau la baza ”(p. 15).
Instrumentul specific pentru cauză și efect pe care l-am folosit pentru acest proiect de depanare a fost o sesiune de cinci de ce, care poate fi utilizată pentru a „pune la îndoială fiecare cauză identificată dacă este un simptom, o cauză de nivel inferior sau o cauză rădăcină” și „continua căutarea adevăratelor cauze fundamentale chiar și după constatarea faptului că s-a găsit o posibilă cauză ”(Andersen și Fagerhaug; 2000, p. 117). Cele cinci de ce exercițiu au implicat supraveghetori, operatori cu diverse niveluri de expertiză și personal din departamentul de resurse umane al clientului. La sfârșit, am avut o serie de tabele care documentează condițiile, oferind tipul de perechi cauză-remediu specificate în hârtia albă DITA Adoption TC.
Prioritizați condițiile și soluțiile
O sesiune lungă de analiză a cauzelor profunde cu supraveghetori, utilizatori și manageri poate fi prea exhaustivă pentru un ghid de depanare destinat unui public de operatori de mașini. Nu uitați niciodată utilizatorii intenționați ai livrării și nevoile lor unice. În timpul experimentului de cinci de ce am ieșit cu unele condiții care au avut mai mult de 15 posibile perechi cauză-remediu. Toate au fost interesante și relevante pentru unele aspecte ale producției de carton. Cu toate acestea, unele s-au întâmplat cel puțin o dată pe săptămână, iar altele au fost legende aproape urbane. Multe dintre soluțiile lor implicau supraveghetori de schimbare sau tehnicieni. Am filtrat rezultatele pe baza a) nevoilor reale ale publicului în ceea ce privește domeniul de aplicare al proiectului și b) frecvenței la nivelul producției.