#81 Tech Writer VS Coduje, czyli pisanie dokumentacji w modelu docs as code

Tech Writer Koduje

Zapewne każdy programista zna albo przynajmniej słyszał o Visual Studio Code (VS Code), czyli darmowym edytorze ze stajni Microsoftu.

Jednak podejrzewamy, że nie każdy Tech Writer wie co to za narzędzie i że można go z powodzeniem używać do tworzenia dokumentacji. Raczej nie przyda nam się jeśli pracujemy z narzędziami typu CCMS, ale za to doskonale sprawdzi się w modelu "docs as code", w którym niepodzielnie od wielu lat króluje Markdown. Mnogość opcji konfiguracyjnych i dostępnych wtyczek sprawia, że ten edytor może okazać się świetnym wyborem dla technoskrybów, którzy ściśle współpracują z programistami.

Rozmawiamy o tym co nam oferuje VS Code, jakie wtyczki przydają się do pisania dokumentacji, jakie ciekawe funkcje można znaleźć w tym edytorze, a nawet o tym jak dodać podstawowe wsparcie dla plików DITA.

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:

• Visual Studio Code (VS Code): https://code.visualstudio.com/https://code.visualstudio.com/
• Wtyczka MDX: https://marketplace.visualstudio.com/items?itemName=unifiedjs.vscode-mdx

• Wtyczka Markdown All in One: https://marketplace.visualstudio.com/items?itemName=yzhang.markdown-all-in-one
• Wtyczka markdownlint: https://marketplace.visualstudio.com/items?itemName=DavidAnson.vscode-markdownlint
• Wtyczka Markdown Preview Enhanced: https://marketplace.visualstudio.com/items?itemName=shd101wyy.markdown-preview-enhanced
• Vale: https://github.com/errata-ai/vale
• Wtyczka Vale VSCode: https://marketplace.visualstudio.com/items?itemName=ChrisChinchilla.vale-vscode
• Wtyczka Write Good Linter: https://marketplace.visualstudio.com/items?itemName=travisthetechie.write-good-linter
• Wtyczka vscode-textlint: https://marketplace.visualstudio.com/items?itemName=taichi.vscode-textlint
• Wtyczka Prettier - Code formatter: https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode
• Wtyczka Code Spell Checker: https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker
• Wtyczka Markdown PDF: https://marketplace.visualstudio.com/items?itemName=yzane.markdown-pdf
• Wtyczka Gremlins tracker for Visual Studio Code: https://marketplace.visualstudio.com/items?itemName=nhoizey.gremlins
• Wtyczka REST Client: https://marketplace.visualstudio.com/items?itemName=humao.rest-client
• Wtyczka GitLens — Git supercharged: https://marketplace.visualstudio.com/items?itemName=eamodio.gitlens

• "Lint, Lint and Away! Linters for the English Language", Chris Chinchilla: https://hackernoon.com/lint-lint-and-away-linters-for-the-english-language-70f4b22cc73c
• "The 2025 Developer Survey", Stack Overflow: https://survey.stackoverflow.co/2025

• "Darwin Information Typing Architecture" (DITA), Wikipedia: https://en.wikipedia.org/wiki/Darwin_Information_Typing_Architecture
• "How can I make DITA catalog.xml work in VS Code?", Stack Overflow: https://stackoverflow.com/questions/64782816/how-can-i-make-dita-catalog-xml-work-in-vs-code