#52 Od przybytku głowa też boli, czyli Tech Writer próbuje utrzymać dokumentację w ryzach
Dokumentacji powinno być tyle ile trzeba, nie więcej, nie mniej.
Nasi goście z firmy Etteplan, Barbara Kardel-Piątkowska i Grzegorz Nowak, na co dzień starają się utrzymać racjonalny poziom ilości dokumentacji i stworzyć rozsądne środowisko pracy nad nią. Kluczem do sukcesu są właściwe planowanie, odpowiednie procedury i narzędzia. Dodatkowego smaczku dodaje jeszcze fakt, że Basia i Grzesiek tworzą dokumentację do maszyn, która rządzi się innymi prawami niż dokumentacja do oprogramowania.
Rozmawiamy o reusie, conditionalach, zarządzaniu treścią i innych ciekawych rzeczach, które mogą być pomocne w opanowaniu zbyt dużej ilości dokumentacji.
Dźwięki wykorzystane w audycji pochodzą z kolekcji "107 Free Retro Game Sounds" dostępnej na stronie dominik-braun.net, udostępnianej na podstawie licencji Creative Commons license CC BY 4.0 (creativecommons.org/license...).
Informacje dodatkowe:
- Etteplan: www.etteplan.com/
- Dyrektywa maszynowa: www.ce-polska.pl/dyrektywa-...
- Simplified Technical English (STE): www.asd-ste100.org/
- Git: git-scm.com/
- Subversion: subversion.apache.org/
- Component Content Management System (CCMS), Wikipedia: en.m.wikipedia.org/wiki/Com...
- Information architecture (IA), Wikipedia: en.wikipedia.org/wiki/Infor...
- "Content reuse – a productivity booster or a vicious circle?", JetBrains blog: blog.jetbrains.com/writersi...
- Profil Basi na LinkedIn: www.linkedin.com/in/barbara...
- Profil Grześka na LinkedIn: www.linkedin.com/in/nowakgp/
