:: ::

DITA w modelu "docs as code"? Kto to widział? Czy to się da zrobić i czy to w ogóle ma sens? Po snuciu teorii na ten temat, przyszedł czas na konkretne działania.

Rozmawiamy o tym co do tej pory udało nam się zrobić, żeby w naszej organizacji wdrożyć "DITA as code". Mówimy o narzędziach, przykładowym procesie robienia zmian w dokumentacji, napotkanych trudnościach i kolejnych krokach.

Jeśli "DITA z gita" jest bliska Waszemu sercu to zapraszamy do odsłuchu.

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:

  • "#16 DITA z Gita", Tech Writer koduje: https://techwriterkoduje.pl/blog/2020/04/22/dita-z-gita
  • "#8 DITA OT - static site generator dla wtajemniczonych", Tech Writer koduje: https://techwriterkoduje.pl/blog/2019/09/28/dita-ot
  • Standard DITA (Darwin Information Typing Architecture): https://en.wikipedia.org/wiki/Darwin_Information_Typing_Architecture
  • Component Content Management System (CCMS): https://en.m.wikipedia.org/wiki/Component_content_management_system
  • Git: https://git-scm.com/
  • "Docs as code", Write the Docs: https://www.writethedocs.org/guide/docs-as-code/
  • Bitbucket: https://bitbucket.org/
  • Git submodules: https://www.atlassian.com/git/tutorials/git-submodule
  • Bitbucket pull requests: https://www.atlassian.com/git/tutorials/making-a-pull-request
  • Oxygen XML: https://www.oxygenxml.com/#bidx-xml-author
  • "Krytyczna podatność w bibliotece Apache Log4j": https://cert.pl/posts/2021/12/krytyczna-podatnosc-w-bibliotece-apache-log4j/
  • Sourcetree: https://www.sourcetreeapp.com/
  • DITA Open Toolkit (DITA OT): https://www.dita-ot.org/
  • Docker: https://www.docker.com/
  • Amazon Simple Storage Service (S3): https://aws.amazon.com/s3/
  • TeamCity: https://www.jetbrains.com/teamcity
  • Schematron: https://www.schematron.com/
  • "Content Reuse": https://paligo.net/docs/en/content-reuse.html
  • Git hooks: https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks
  • "Readability – what is it and how do I improve it?", Paweł Kowaluk (soap! 2018): https://www.youtube.com/watch?v=LzrHrIOHhz8

Jest to odcinek podkastu:
Tech Writer koduje

Podcast o technicznej stronie tworzenia dokumentacji w IT. Skupiamy się na tym jak Tech Writer może wpasować się w środowisko programistów zarówno pod kątem sposobu pracy jak i używanych technologii, narzędzi i rozwiązań. Staramy się też pokazać, że praca Tech Writera może być ciekawa i rozwijająca pod kątem umiejętności technicznych.

Kategorie:
Technologia

Informacja dotycząca prawa autorskich: Wszelka prezentowana tu zawartość podkastu jest własnością jego autora

Wyszukiwanie

Kategorie