ktoprzemawiaPodcasty dookoła ITPolecane podcasty

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 😀

Tech Writer Koduje

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.

Kiedyś było lepiej… A może tak nam się tylko wydaje. Na pewno było inaczej. Powszechny dostęp do dużych modeli językowych sporo namieszał. Teraz możemy użyć takiego czy innego czata właściwie do wszystkiego – rozpisania planu treningowego, zaplanowania wycieczki, stworzenia aplikacji i napisania dokumentacji. Jednak sam fakt, że możemy czegoś użyć nie oznacza od razu, że powinniśmy.

Pewne rzeczy zostały rozwiązane dawno temu i nie ma sensu rozwiązywać ich ponownie za pomocą LLMów. W tym odcinku rozmawiamy o narzędziach i rozwiązaniach ”starego” typu, które mogą nam pomóc w procesie tworzenia dokumentacji. Poszukujemy złotego środka, który pozwala na mariaż starej i nowej rzeczywistości.

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/).

Linki:

”Token maxxing”, Wikipedia: https://en.wikipedia.org/wiki/Token_maxxing
”Lint, Lint and Away! Linters for the English Language”, Chris Ward: https://dzone.com/articles/lint-lint-and-away-linters-for-the-english-languag
Visual Studio (VS) Code: https://code.visualstudio.com/
IntelliJ IDEA: https://www.jetbrains.com/idea/
Code Spell Checker: https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker
Gremlins tracker: https://github.com/nhoizey/vscode-gremlins
Alex: https://alexjs.com/
Write Good Linter: https://github.com/TravisTheTechie/vscode-write-good#readme
textlint: https://github.com/textlint/vscode-textlint
LanguageTool: https://languagetool.org/pl
Hemingway Editor: https://hemingwayapp.com/
Vale: https://vale.sh/
Grazie: https://www.jetbrains.com/grazie/
Schematron: https://www.schematron.com/
”Readability – what is it and how do I improve it?”, Paweł Kowaluk (soap! 2018): https://www.youtube.com/watch?v=LzrHrIOHhz8
”Automated readability index”, Wikipedia: https://en.wikipedia.org/wiki/Automated_readability_index
Simplified Technical English: https://www.asd-ste100.org/
”Standard DITA (Darwin Information Typing Architecture)”, Wikipedia: https://en.wikipedia.org/wiki/Darwin_Information_Typing_Architecture
MDX: https://mdxjs.com/