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 as code” to filozofia, która głosi, żeby tworzyć dokumentację za pomocą tych samych narzędzi i procesów co oprogramowanie. W zamian za to otrzymujemy szereg benefitów, takich jak lepsza współpraca z programistami, synchronizacja kodu i dokumentacji, wersjonowanie, automatyczne testy oraz ogólne poczucie, że dokumentacja to wspólna odpowiedzialność.
Czy takie podejście sprawdza się w praktyce? Czy nie są to tylko puste obietnice, których w rzeczywistości nie da się spełnić? W tym odcinku konfrontujemy artykuł ”Docs as code is a broken promise” z naszymi własnymi doświadczeniami i przekonaniami. Uwaga, spoiler! Jako żarliwi zwolennicy docs as code, staramy się pokazać, że pomimo wyzwań jakie ze sobą niesie, jest to podejście, które dobrze się sprawdza w świecie dokumentacji do 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 as code is a broken promise”, Sarah Moir: https://thisisimportant.net/posts/docs-as-code-broken-promise/
- ”Docs as Code”, Write the Docs: https://www.writethedocs.org/guide/docs-as-code/
- ”Documentation as Code: why you need it and how to get started”, Swimm Team: https://swimm.io/learn/code-documentation/documentation-as-code-why-you-need-it-and-how-to-get-started
- Git: https://git-scm.com/
- Subversion (SVN): https://subversion.apache.org/
- Mercurial: https://www.mercurial-scm.org/
- Perforce: https://www.perforce.com/solutions/version-control
- ”What version control systems do you regularly use?”, JetBrains: https://www.jetbrains.com/lp/devecosystem-2023/team-tools/#tools_vcs
- ”Component content management system (CCMS)”, Wikipedia: https://en.wikipedia.org/wiki/Component_content_management_system
- GitLab: https://gitlab.com/
- GitHub: https://github.com/
- The Zen of Python: https://peps.python.org/pep-0020/#the-zen-of-python
- MadCap Flare: https://www.madcapsoftware.com/products/flare/
- Markdown: https://daringfireball.net/projects/markdown/
- AsciiDoc: https://asciidoc.org/
- Visual Studio Code (VS Code): https://code.visualstudio.com/
- Kotlin: https://kotlinlang.org/
- IntelliJ IDEA: https://www.jetbrains.com/idea/
- ”Emancipation: Why the heck would a tech writer use enterprise tools?”, Paweł Kowaluk: https://meetcontent.github.io/events/krakow/2024/20
- Docusuarus: https://docusaurus.io/
- GitLens: https://marketplace.visualstudio.com/items?itemName=eamodio.gitlens
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