Dziś kolejna odsłona podcastu Tech Writer koduje. Tym razem tematem przewodnim jest jakość dokumentacji.
Gościem 23 odcinka podcastu jest Rafał Pawlicki, specjalista do spraw dokumentacji technicznej z Krakowa. Wraz z Michałem i Pawłem zastanawiają się w jaki sposób najlepiej zmierzyć jakość dokumentacji oraz czym się kierować w jej ocenie.
Jakość dokumentacji - czym jest?
Rafał definiuje jakość dokumentacji w ten sposób - dobra dokumentacja to taka, która spełnia wyznaczone przez użytkownika, korporację, producenta czy twórcę standardy i da się ją sprawdzić za pomocą przyjętych metryk.
Rozmówcy zauważyli, że metryk jakości nie da się sprawdzić automatycznie biorąc pod uwagę posiadane dane. Uważają, że można jedynie sprawdzić jej spójność z przyjętymi w danej jednostce standardami.
W dalszej części materiału panowie zastanawiają się jak stworzyć najlepszą dokumentację. Na podstawie własnych doświadczeń przyjęli w tym celu następujące kroki:
- Ustalenie wewnętrznych standardów jakości, które są ściśle przestrzegane,
- Kontrola jakości czyli sprawdzenie czy dokumentacja spełnia przyjęte cele,
- Weryfikacja standardów czyli rozwijanie ich w taki sposób, by dokumentacja która je spełniała była coraz lepsza.
Niby proste, jednak jak utrzymywać wewnętrzne standardy jednocześnie ucząc ludzi pisania dobrej dokumentacji? W jaki sposób mierzyć efektywność dokumentacji?
Aby móc odpowiedzieć na te pytania należy zastanowić się jak stworzyć model oceny dokumentacji pod kątem jakości i dojrzałości, a następnie jak wykorzystać te informacje do planowania pracy dokumentacyjnej. Kolejnym elementem, który analizują rozmówcy jest zbieranie danych od użytkowników oraz wykorzystywanie ich do wdrażania zmian w organizacji.
W dalszej części podcastu panowie dyskutują o własnych doświadczeniach. Które metryki najlepiej sprawdzały się do tej pory? Które działają najlepiej osobno, a które w połączeniu? Które elementy może sprawdzać automat, a które powinny być weryfikowane przez człowieka?
Zachęcamy do posłuchania i dyskusji na temat Waszych doświadczeń z jakością dokumentacji i sposobami na jej mierzenie.