#90 Tech Writer cofa się w czasie, czyli jak bez AI robić lepszą dokumentację
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/