Zbavte se zlozvyku špatné dokumentace

-- 19.05.11 13:22

Vyhněte se chybějící, nesprávné, špatně napsané nebo nekompletní dokumentaci a zlepšete tím své projekty IT ve výrobě, návrhy automatizace nebo řízení.

Myslíte si, že jste hotovi s projektem IT ve výrobě, návrhem automatizace nebo řízení? Zkontrolujte svou dokumentaci, abyste se vyhnuli jednomu z nejhorších zlozvyků projektů – chybějící, nesprávné, špatně napsané nebo neúplné dokumentaci. Lidstvo zná písmo už od roku 2800 před naším letopočtem a s téměř 5 000 let trvající zkušeností bychom už měli mít vypracován ten nejlepší způsob předávání znalostí. Nicméně mnoho projektů využívá ekvivalent sezení kolem ohně a vyprávění příběhů jakožto primární metodu pro sdělování znalostí a hodnocení projektových návrhů. V moderních projektech oheň nahrazuje žhnoucí obrazovka webové konference, ale koncept je stejný.

Mezi nejhorší zlozvyky neúspěšných projektů patří nedokumentování, chybějící dokumenty, nesprávné dokumenty, špatně napsané dokumenty nebo absence kontroly a oprav dokumentů. Dokumentace může být prokletím kteréhokoli projektu. Velkému procentu projektů, které selhaly, byla vyčítána špatná, chybějící nebo nesprávná dokumentace. Jedním z hlavních důvodů je to, že technici obvykle bývají špatní spisovatelé. Asi je něco v mozku některých techniků, co je v rozporu se schopností srozumitelného a efektivního písemného projevu, anebo je to tím, že se někteří technici nenaučili dovednosti kritického psaní.

Mnoho techniků ani neví, jak špatně píše, protože se u jejich dokumentů hodnotí technická správnost, nikoli úplnost, přehlednost a srozumitelnost Ať už je za nedostatkem dovednosti psaní cokoli, mnoho projektových techniků (a jejich kolegů v oblasti IT) dává přednost „dokumentování“ koncepcí a znalostí prostřednictvím schůzek a seminářů. Výsledkem toho však je, že značná část projektových znalostí se udržuje pouze v hlavách lidí. Tyto projekty možná produkovaly mnoho dokumentace, v níž však chybí použitelné znalosti. U interních projektů, které mají být dodány konečným uživatelům, neexistuje žádná alternativa dobré uživatelské dokumentace a použitelných školicích příruček.U neúspěšných projektů nejsou tyto dokumenty součástí plánu vývoje, ale jejich vypracování bývá plánováno „až poté, co dokončíme kód“.

Jde o krátkozraké jednání, což nevyhnutelně vede k mnoha problémům v pozdější fázi projektu, které obvykle vyžadují rozsáhlé přepracování.Bez práce na těchto dokumentech už během návrhu se neukáže použitelnost produktu dříve, než je kód dokončen. Zejména projekty převodu technologií jsou náchylné na zlozvyk špatné dokumentace. Tyto projekty zahrnují převod technologií automatizačních systémů, řídicích strategií, výrobních postupů a předpisů. Mohou vyžadovat přesun jednoho nebo více techniků na pracoviště klienta na dobu několika týdnů nebo měsíců, aby zde nainstalovali a zprovoznili nový systém. Jak poznáte, že váš projekt trpí tímto zlozvykem? Napovědět mohou následující příznaky:

• výměna informací často probíhá formou ekvivalentního „vyprávění u ohně“, kdy technici cestují na jiná pracoviště, aby tam předali hromadu informací,

• neexistence uživatelských příruček k instalaci a údržbě systému,

• nikomu není přidělena odpovědnost za vytvoření uživatelské dokumentace,

• u kontrol dokumentů se nezohledňuje jejich přehlednost a srozumitelnost,

• neexistuje mechanismus zpětné vazby na pisatele pro zlepšení jejich písemného projevu,

• mnoho předělávek, protože někdo „chyběl na schůzce, kde jsme o tom hovořili“.

Abyste se zbavili zlozvyku špatné dokumentace, měl by ve vašem projektu zavládnout přístup typu „pokud něco není dobře zdokumentováno, pak to můžete rovnou vyhodit, protože to stejně nakonec uděláte“. Nikdo nechce vyhazovat do koše provedenou práci, takže tento přístup  zdůrazňuje důležitost použitelné a srozumitelné  dokumentace. Zlozvyku špatné dokumentace se těžko zbavuje, ale má-li projekt uspět, je to nezbytné. Jen málo úspěšných projektů, pokud vůbec nějaký, nemá dobře napsanou a snadno srozumitelnou dokumentaci.

Dennis Brandl je prezident společnosti BR&L Consulting se sídlem v Cary v Severní Karolíně, www.brlconsulting.com. Jeho společnost je zaměřena na IT pro výrobu. Můžete jej kontaktovat na e-mailové adresedbrandl@brlconsulting.com.

Autor: Dennis Brandl