使用Player FM应用程序离线!
#65 Tech Writer broni docs as code, czyli klasyczne "u mnie działa"
Manage episode 415182076 series 2508014
"Docs as code" to filozofia, która głosi, żeby tworzyć dokumentację za pomocą tych samych narzędzi i procesów co oprogramowanie. W zamian za to otrzymujemy szereg benefitów, takich jak lepsza współpraca z programistami, synchronizacja kodu i dokumentacji, wersjonowanie, automatyczne testy oraz ogólne poczucie, że dokumentacja to wspólna odpowiedzialność.
Czy takie podejście sprawdza się w praktyce? Czy nie są to tylko puste obietnice, których w rzeczywistości nie da się spełnić? W tym odcinku konfrontujemy artykuł "Docs as code is a broken promise" z naszymi własnymi doświadczeniami i przekonaniami. Uwaga, spoiler! Jako żarliwi zwolennicy docs as code, staramy się pokazać, że pomimo wyzwań jakie ze sobą niesie, jest to podejście, które dobrze się sprawdza w świecie dokumentacji do oprogramowania.
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/).
Informacje dodatkowe:
- "Docs as code is a broken promise", Sarah Moir: https://thisisimportant.net/posts/docs-as-code-broken-promise/
- "Docs as Code", Write the Docs: https://www.writethedocs.org/guide/docs-as-code/
- "Documentation as Code: why you need it and how to get started", Swimm Team: https://swimm.io/learn/code-documentation/documentation-as-code-why-you-need-it-and-how-to-get-started
- Git: https://git-scm.com/
- Subversion (SVN): https://subversion.apache.org/
- Mercurial: https://www.mercurial-scm.org/
- Perforce: https://www.perforce.com/solutions/version-control
- "What version control systems do you regularly use?", JetBrains: https://www.jetbrains.com/lp/devecosystem-2023/team-tools/#tools_vcs
- "Component content management system (CCMS)", Wikipedia: https://en.wikipedia.org/wiki/Component_content_management_system
- GitLab: https://gitlab.com/
- GitHub: https://github.com/
- The Zen of Python: https://peps.python.org/pep-0020/#the-zen-of-python
- MadCap Flare: https://www.madcapsoftware.com/products/flare/
- Markdown: https://daringfireball.net/projects/markdown/
- AsciiDoc: https://asciidoc.org/
- Visual Studio Code (VS Code): https://code.visualstudio.com/
- Kotlin: https://kotlinlang.org/
- IntelliJ IDEA: https://www.jetbrains.com/idea/
- "Emancipation: Why the heck would a tech writer use enterprise tools?", Paweł Kowaluk: https://meetcontent.github.io/events/krakow/2024/20
- Docusuarus: https://docusaurus.io/
- GitLens: https://marketplace.visualstudio.com/items?itemName=eamodio.gitlens
70集单集
Manage episode 415182076 series 2508014
"Docs as code" to filozofia, która głosi, żeby tworzyć dokumentację za pomocą tych samych narzędzi i procesów co oprogramowanie. W zamian za to otrzymujemy szereg benefitów, takich jak lepsza współpraca z programistami, synchronizacja kodu i dokumentacji, wersjonowanie, automatyczne testy oraz ogólne poczucie, że dokumentacja to wspólna odpowiedzialność.
Czy takie podejście sprawdza się w praktyce? Czy nie są to tylko puste obietnice, których w rzeczywistości nie da się spełnić? W tym odcinku konfrontujemy artykuł "Docs as code is a broken promise" z naszymi własnymi doświadczeniami i przekonaniami. Uwaga, spoiler! Jako żarliwi zwolennicy docs as code, staramy się pokazać, że pomimo wyzwań jakie ze sobą niesie, jest to podejście, które dobrze się sprawdza w świecie dokumentacji do oprogramowania.
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/).
Informacje dodatkowe:
- "Docs as code is a broken promise", Sarah Moir: https://thisisimportant.net/posts/docs-as-code-broken-promise/
- "Docs as Code", Write the Docs: https://www.writethedocs.org/guide/docs-as-code/
- "Documentation as Code: why you need it and how to get started", Swimm Team: https://swimm.io/learn/code-documentation/documentation-as-code-why-you-need-it-and-how-to-get-started
- Git: https://git-scm.com/
- Subversion (SVN): https://subversion.apache.org/
- Mercurial: https://www.mercurial-scm.org/
- Perforce: https://www.perforce.com/solutions/version-control
- "What version control systems do you regularly use?", JetBrains: https://www.jetbrains.com/lp/devecosystem-2023/team-tools/#tools_vcs
- "Component content management system (CCMS)", Wikipedia: https://en.wikipedia.org/wiki/Component_content_management_system
- GitLab: https://gitlab.com/
- GitHub: https://github.com/
- The Zen of Python: https://peps.python.org/pep-0020/#the-zen-of-python
- MadCap Flare: https://www.madcapsoftware.com/products/flare/
- Markdown: https://daringfireball.net/projects/markdown/
- AsciiDoc: https://asciidoc.org/
- Visual Studio Code (VS Code): https://code.visualstudio.com/
- Kotlin: https://kotlinlang.org/
- IntelliJ IDEA: https://www.jetbrains.com/idea/
- "Emancipation: Why the heck would a tech writer use enterprise tools?", Paweł Kowaluk: https://meetcontent.github.io/events/krakow/2024/20
- Docusuarus: https://docusaurus.io/
- GitLens: https://marketplace.visualstudio.com/items?itemName=eamodio.gitlens
70集单集
所有剧集
×欢迎使用Player FM
Player FM正在网上搜索高质量的播客,以便您现在享受。它是最好的播客应用程序,适用于安卓、iPhone和网络。注册以跨设备同步订阅。