Byla jednou jedna písařka

V CZ.NIC byla vloni vůbec poprvé obsazena pozice technického dokumentaristy a tak bych vám tuto profesi chtěla představit a přiblížit, jakou hraje roli v naší organizaci.

Písaři ve starém Egyptě byli profesionálové speciálně vyučení v umění psaní a aritmetice, kteří ručně zaznamenávali architektonické, administrativní a ekonomické činnosti. Ačkoli se význam tohoto slova v průběhu věků měnil v souvislosti s technickým pokrokem, vidím zde podobnost s profesí relativně mladou v našich zemích, která je v anglicky mluvícím světě známá pod pojmem Technical Writer a v naší organizaci byla označena slovním spojením „technický dokumentarista“.

Slovo „writer“ by většina z nás nejspíš instinktivně přeložila jako „spisovatel“, avšak spisovatel je povolání spíše více kreativní a jeho díla jsou zamýšlena především pro zábavu širokého obecenstva. Oproti tomu technický dokumentarista (nebo technický písař) píše pro užší okruh čtenářů, jejichž schopnosti a vědomosti musí brát v úvahu, za konkrétním účelem a nemá prostor pro přílišnou kreativitu, neboť by tím mohl svoji práci v tomto případě spíše znehodnotit než obohatit. Kvalitami obsahu technické dokumentace jsou stručnost, jasnost a přiměřenost hloubky informací, takže pro nějaké básnické obraty a košaté metafory tu není místo. Dokumentarista také nepíše z hlavy, ale svou práci zakládá na průzkumu různých zdrojů informací (články, knihy, rozhovory s odborníky na danou oblast (SMEs) a budoucími čtenáři, dotazníky, experimentování s dokumentovaným objektem).

Kromě tvorby obsahu mnohdy buď sám provádí další přidružené činnosti nebo spolupracuje s odborníky například na grafický design, typografii a sazbu nebo návrh webových prezentací, aby dokumentace vypadala profesionálně, značkovací jazyky pro strukturování textu a počítačové skriptování, které podporuje automatizaci dokumentování, technický překlad, pokud se dokumentuje v cizích jazycích, úpravu videozáznamu, neboť nemusí vždy jít jen o textové dokumenty, a další související oblasti.

Jako dokumentarista mohu najít uplatnění v různých odvětvích, avšak v rámci technického oddělení CZ.NIC se specializuji na dokumentaci, která má napomáhat lidem v porozumění a užívání (nejen našich vlastních) softwarových systémů.

Přednostně se věnuji systému FRED, který nejenže je klíčový pro sdružení samotné, ale má také potenciál pro externí zájemce, kteří by tento systém chtěli nasadit a používat pro vedení vlastního registru. Budoucí dokumentace systému FRED bude zahrnovat popis funkčních charakteristik pro zájemce, aby mohli zjistit, zda by jim systém vyhovoval, popis architektury k hlubšímu porozumění systému, který je třeba pro jeho správu a další vývoj, příručky pro správce i uživatele a implementační dokumentaci, kterou jistě ocení zejména registrátoři.

Dále okrajově přispívám k dokumentování dalších projektů, např. mojeID nebo KnotDNS, u nichž pomáhám revizemi již existujících textů ke zdokonalení jejich pojetí a provedení.

Souběžně se zabývám také zavedením dokumentování jako takového, což znamená navrhnout jednak postup, jakým se bude provádět, nástroje a konvence, které se k tomu využijí, a také náležitosti, které by jednotlivé dokumenty měly mít. Na jednu stranu je to velká výzva, ale současně ji vnímám také jako ohromnou příležitost pro seberealizaci a získání zkušeností, kterou by mi většina kolegů-dokumentaristů záviděla, neboť je to příležitost velmi vzácná.

Ač to nemusí být zřejmé, nejsem jediný tvůrce dokumentace v oddělení. Existují totiž typy dokumentace, kterou dokumentarista nemůže dělat přímo, protože je například příliš technická, a mnohem snáze ji vytvoří daný odborník. Typickým příkladem může být dokumentace provázející vývoj software, tedy analýzu (specifikace), návrh (architektury, algoritmů, protokolů), kódování (API dokumentace) a testování (testovací postupy, zprávy z testování). Dalším příkladem je dokumentace, která pomáhá organizovat práci, např. plány nebo vnitřní předpisy – ta je obvykle v kompetenci managementu, ale podílí se na ní i ostatní pracovníci.

Mým úkolem je tedy zavést proces dokumentování, vést přehled existující dokumentace a navrhnout její doplnění, pokud vyvstane potřeba sdělit další informace, ale především zprostředkovat softwarové technologie snadno uchopitelným způsobem, takže našim výtvorům budeme rozumět nejen my, ale vy také.

Autor:

Zanechte komentář