Tento workshop má za cíl zaměřit se na pokročilá témata v technickém dokumentování (Technical Writing) se specializací na softwarovou dokumentaci (ale nikoliv výlučně *). Účelem je sdílet a prodiskutovat s ostatními zkušenosti týkající se procesu dokumentování a nástrojů podporujících tento proces. Konkrétními metodami návrhu, organizace a vývoje dokumentů ani jazykem a formálními náležitostmi dokumentů se zde zabývat však nebudeme. Účastníci budou mít příležitost dozvědět se o různých nástrojích a nechat se inspirovat k vylepšení vlastního procesu pozorováním, jak se to dělá jinde.

*Pokud pracujete v jiném oboru než je vývoj software a myslíte si, že máte dobře zvládnutý proces dokumentování nebo že používáte zajímavé nebo neobvyklé nástroje, jste vítáni také.

Workshop bude mít podobu série krátkých prezentací (maximálně 20minutových) následovaných odpověďmi na otázky posluchačů. Prezentace mohou být organizovány do několika bloků, z nichž každý bude uzavřen krátkou diskuzí. (Organizace workshopu je závislá na počtu prezentujících, který bude znám později.) Maximum prezentujících je 10 a celkový počet všech účastníků je 20 (omezeno kapacitou místnosti).

Jazyk workshopu (čeština/angličtina) bude záviset na přihlášených účastnících a bude oznámen později.

Osnova prezentace

1. Představte vaši organizaci, produkt(y) a pracovní prostředí
   
2. Jaké typy obsahu spravujete?
   např. uživatelské a administrátorské příručky, vývojářské specifikace, dok. pro podporu uživatele (znalostní základna), jiné?
   
3. Spolupracujete s dalšími lidmi?
   Kolik lidí/týmů u vás spolupracuje?
   
4. Jaká dostáváte zadání/Které údaje jsou pro vás dostupné pro zahájení úkolu?
   
5. Používáte
   ... popis procesu/procesní směrnici?
   ... obecné náležitosti dokumentace?
   ... příručku stylu (style guide)?
   ... jiné dokumenty, které popisují koncepci dokumentování ve vaší organizaci?
   
6. Sdělte obecné body procesu (můžete využít svoji směrnici)
   Jak kroky souvisejí s vývojem software?
   
7. Jaké nástroje používáte pro podporu tohoto procesu?
   Jejich výhody a nevýhody
   Demonstrace
   

Nemusíte všechny body osnovy pokrýt stejným dílem, můžete si vybrat otázky, které považujete za zajímavé, nebo vynechat ty, které se na vás nevztahují.

Technické vybavení

Místnost je vybavena 21 počítači s Ubuntu. Počítač vepředu je připojen k projektoru. Můžete si přinést vlastní zařízení, pokud byste chtěli demonstrovat nástroje, které vyžadují instalaci, ale musíte mít konektor HDMI nebo příslušný adaptér.

Organizace prezentací

Pokud chcete prezentovat nebo to zvažujete, kontaktujte prosím organizátorku na adrese zuzana.ansorgova@nic.cz pro více informací, oznámení vaší aktivní účasti a další domluvu.

/akademie/course/114/detail/