Tech Writer koduje
Technoskryba – czy takie pojęcie jest Wam znane, może Tech Writer brzmi bardziej znajomo? Obie nazwy wskazują na to samo stanowisko, w którego arkana w swoim podcascie wprowadzają Miachał Skowron i Paweł Kowaluk.
Pewnie nie będzie dla Was zaskoczeniem, jak kolejny raz powiem, że na ten duet trafiłem słuchając Porozmawiajmy o IT Krzyśka Kempińskiego, gdzie w ramach #114 odcinka starali się przybliżyć czym zajmuje się Technical Writer. Czy to się udało? Przybliżyć – zdecydowanie tak, ale jak się okazuje dedykowany podcast to idealna przestrzeń, aby dzielić się doświadczeniem i dobrymi praktykami w tym zakresie.
Słuchając kolejnych odcinków niejednokrotnie możemy odnaleźć analogię do pracy programisty, a poruszane tematy nie zamykają się tylko stricte w obszarze powstawania dokumentacji technicznej. Doskonałym przykładem może być odcinek #38, w którym podnoszony jest temat… podatności i wypływu dokumentacji technicznej na bezpieczeństwo projektowanych systemów.
Skupiamy się na tym jak Tech Writer może wpasować się w środowisko programistów zarówno pod kątem sposobu pracy jak i używanych technologii, narzędzi i rozwiązań. Staramy się też pokazać, że praca Tech Writera może być ciekawa i rozwijająca pod kątem umiejętności technicznych.
Pracując jako programista nigdy nie patrzyłem na siebie przez pryzmat technoskryby, niemniej Ci panowie uświadomili mi, że elementy kompetencji, które powinien posiadać tech writer są również nieodzowne w pracy programisty.
Na pewno zawsze warto poszerzać swoje horyzonty, a zrozumienie na czym polega praca poszczególnych członków zespołu, bez wątpienia ma pozytywny wpływ na komunikację w jego obrębie, o czym zresztą wspominałem zapraszając do słuchania Tech Writer koduje w odcinku o podcastach dookoła IT 2022:
Przede mną do odsłuchania jeszcze bogate archeo, natomiast nowe odcinki staram się wysłuchiwać w miarę regularnie, do czego oczywiście zachęcam również Ciebie 😀
Podcast o technicznej stronie tworzenia dokumentacji w IT. Skupiamy się na tym jak Tech Writer może wpasować się w środowisko programistów zarówno pod kątem sposobu pracy jak i używanych technologii, narzędzi i rozwiązań. Staramy się też pokazać, że praca Tech Writera może być ciekawa i rozwijająca pod kątem umiejętności technicznych.
„Docs like code” czy „Docs as code” to model tworzenia dokumentacji, którego głównym założeniem jest traktowanie dokumentacji jak kodu pod kątem procesów oraz narzędzi, których używamy do jej tworzenia. Jednak czy można pójść o krok dalej i rozszerzyć założenia tego modelu na sam proces pisania dokumentacji?
Rozmawiamy o tym czy pisanie dokumentacji i kodowanie są do siebie podobne, czy kodujący Tech Writer ma jakieś dodatkowe umiejętności, dzięki którym jest w stanie dostarczać dokumentację lepszej jakości i czy dokumentacja mogłaby czerpać korzyści z testów, które są tworzone dla oprogramowania.
Dźwięki wykorzystane w audycji pochodzą z kolekcji „107 Free Retro Game Sounds” dostępnej na stronie https://dominik-braun.net, udostępnianej na podstawie licencji Creative Commons license CC BY 4.0 (https://creativecommons.org/licenses/by/4.0/).
Informacje dodatkowe:
- „Docs like code”, Anne Gentle: https://www.docslikecode.com/book/
- „Docs as code”, Write the Docs: https://www.writethedocs.org/guide/docs-as-code/
- #39 DITA as code, czyli klasyczny standard w nowoczesnym wydaniu”, Tech Writer koduje: https://techwriterkoduje.pl/blog/2022/02/14/dita-as-code
- Standard DITA (Darwin Information Typing Architecture): https://en.wikipedia.org/wiki/Darwin_Information_Typing_Architecture
- Oxygen XML: https://www.oxygenxml.com/#bidx-xml-author
- IntelliJ IDEA: https://www.jetbrains.com/idea/
- Microsoft Word: https://www.microsoft.com/pl-pl/microsoft-365/word
- „Programowanie imperatywne oraz deklaratywne”, Codenga: https://codenga.pl/artykuly/poradniki/programowanie-imperatywne-oraz-deklaratywne
- React: https://pl.reactjs.org/
- Programowanie obiektowe: https://pl.wikipedia.org/wiki/Programowanie_obiektowe
- Docusaurus: https://docusaurus.io/
- Behavior-driven development (BDD): https://pl.wikipedia.org/wiki/Behavior-driven_development
- Cucumber: https://cucumber.io/
- „Rodzaje testów oprogramowania”, Testerzy.pl: https://testerzy.pl/baza-wiedzy/artykuly/rodzaje-testow-oprogramowania
- Test-driven development (TDD): https://pl.wikipedia.org/wiki/Test-driven_development
- Foobar: https://pl.wikipedia.org/wiki/Foobar
- Nuxt: https://nuxtjs.org/
Linki
Po więcej podcastowych polecajek zapraszam na: https://itity.pl/podcasty/ oraz do śledzenia #ktoprzemawia w SM.
Nie chcesz przegapić następnych polecajkowyh recenzji – zapisz się na newsletter – raz w miesiącu prześlę Ci informację o tym co działo się na w świecie podcastów i na blogu 😊
Dobrego odbioru
Damian
Dodaj komentarz