Trudno nie zgodzić się z tym, że tworzenie dokumentacji do oprogramowania wymaga wiedzy technicznej, szczególnie jeśli pracujesz w modelu docs as code. Natomiast trudno jest określić jaki poziom tej wiedzy powinien być. Czy jeśli pracuję z deweloperami to muszę znać ich narzędzia prawie tak samo dobrze jak oni? Czy wręcz odwrotnie - mogę się w ogóle nimi nie przejmować?

Jak zwykle prawda leży po środku. Powinno się znać te narzędzia na tyle na ile jest to potrzebne, żeby być lepszym technoskrybą - nie bardziej i nie mniej. W naszej rozmowie poszukujemy tego środka i dzielimy się naszymi praktycznymi wskazówkami, które sprawią, że zdobywanie wiedzy technicznej stanie się tylko środkiem do osiągnięcia Twojego celu a nie celem samym w sobie.

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:

• Arbortext: https://www.ptc.com/en/products/arbortext
• "Docs as Code", Write the Docs: https://www.writethedocs.org/guide/docs-as-code/
• "Jak pracować z narzędziami deweloperskimi - wskazówki dla tech writerów", techwriter.pl: https://techwriter.pl/jak-pracowac-z-narzedziami-nie-bedac-programista
• IntelliJ IDEA: https://www.jetbrains.com/idea/
• "Git (oprogramowanie)", Wikipedia: https://pl.wikipedia.org/wiki/Git_(oprogramowanie)
• Markdown: https://daringfireball.net/projects/markdown/syntax
• "Kurde! Reuse popsuł mi searcha", techwriter.pl: https://techwriter.pl/reuse-zly-dla-searcha/
• "Terminal", Filmweb: https://www.filmweb.pl/film/Terminal-2004-106408
• Visual Studio (VS) Code: https://code.visualstudio.com
• "CI/CD", Wikipedia: https://en.wikipedia.org/wiki/CI/CD
• "Wiersz poleceń", Wikipedia: https://pl.wikipedia.org/wiki/Wiersz_polece%C5%84
• Oxygen XML: https://www.oxygenxml.com/
• "Darwin Information Typing Architecture" (DITA), Wikipedia: https://en.wikipedia.org/wiki/Darwin_Information_Typing_Architecture
• AsciiDoc: https://asciidoc.org/
• reStructuredText: http://docutils.sourceforge.net/rst.html
• Static site generator: https://www.gatsbyjs.com/docs/glossary/static-site-generator/
• DITA Open Toolkit (DITA OT): https://www.dita-ot.org/
• "Component content management system (CCMS)", Wikipedia: https://en.wikipedia.org/wiki/Component_content_management_system
• Jamstack: https://jamstack.org/
• Yarn: https://yarnpkg.com/
• "What is Amazon S3", Amazon docs: https://docs.aws.amazon.com/AmazonS3/latest/userguide/Welcome.html
• Wtyczka Prettier - Code formatter: https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode
• Wtyczka GitLens — Git supercharged: https://marketplace.visualstudio.com/items?itemName=eamodio.gitlens
• Wtyczka Code Spell Checker: https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker
• "API", Wikipedia: https://en.wikipedia.org/wiki/API
• Wtyczka REST Client: https://marketplace.visualstudio.com/items?itemName=humao.rest-client
• Postman API client: https://www.postman.com/product/api-client/
• cURL: https://curl.se/
• „Ciemność, widzę ciemność, ciemność widzę - czyli jak poskromić linię komend", techwriter.pl: https://techwriter.pl/linia-komend