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/

We thought that after so many years in tech comm we knew a lot about this field. Then, we met Sharon Burton who proved us wrong. She is a seasoned Tech Writer and the author of the "Women in Technical Communication" book. It contains 69 stories of female experts, which show us the intricate history of technical communication.

Sharon joined us in this episode to talk about the evolution of the Technical Writer role, technological shifts in the last several decades that affected the process of writing documentation and challenges that women have to face in the IT industry.

Sounds used in this episode are part of the "107 Free Retro Game Sounds" collection, which is available at https://dominik-braun.net and shared under the Creative Commons license CC BY 4.0 (https://creativecommons.org/licenses/by/4.0/).

Show notes:

• "Women in Technical Communication", Sharon Burton,: https://www.sharonburton.com/
• The Society for Technical Communication (STC): https://en.wikipedia.org/wiki/Society_for_Technical_Communication
• Tekom: https://www.technical-communication.org/
• MadCap Flare: https://www.madcapsoftware.com/products/flare/
• "Docs as Tests & AI", Manny Silva: https://www.docsastests.com/docs-as-tests-book/
• Topic-based authoring: https://www.madcapsoftware.com/blog/what-is-topic-based-authoring/
• CAKE Conf: https://cakeconf.contentbytes.pl/
• "Darwin Information Typing Architecture (DITA)", Wikipedia: https://en.wikipedia.org/wiki/Darwin_Information_Typing_Architecture
• "Docs as Code", Write the Docs: https://www.writethedocs.org/guide/docs-as-code/
• Write the Docs (WTD): https://www.writethedocs.org/
• “Everybody Lies: Big Data, New Data, and What the Internet Can Tell Us About Who We Really Are”, Seth Stephens-Davidowitz: https://www.goodreads.com/en/book/show/28512671-everybody-lies

Ciężko jest wbić gwoździa kapciem. Lepiej użyć do tego młotka.

W komunikacji technicznej, tak jak w życiu codziennym, odpowiednie narzędzie ułatwia nam osiągnięcie celu. Jednak wybór tego odpowiedniego to niełatwe zadanie. Oferta jest bardzo bogata, producenci obiecują złote góry, a liczba wymagań jest zazwyczaj długa. Rozmawiamy o tym jak wygląda kompletny proces wdrażania narzędzia w organizacji - od pomysłu do implementacji.

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:

• "Jak wybierać narzędzia?", techwriter.pl: https://techwriter.pl/jak-wybierac-narzedzia
• "Wdrażanie narzędzia w organizacji - szybki kurs pilotażu", techwriter.pl: https://techwriter.pl/szybki-kurs-pilotazu
• Syllabus ITCQF: https://www.gasq.org/files/content/gasq/downloads/certification/ITCQF/ITCQF_Syllabus_v2_0Jun2020.pdf