Tech Writer Koduje

#41 Tech Writer rozważa podobieństwa i różnice między kodowaniem a pisaniem dokumentacji

Listen Later

"Docs like code" czy "Docs as code" to model tworzenia dokumentacji, którego głównym założeniem jest traktowanie dokumentacji jak kodu pod kątem procesów oraz narzędzi, których używamy do jej tworzenia. Jednak czy można pójść o krok dalej i rozszerzyć założenia tego modelu na sam proces pisania dokumentacji?

Rozmawiamy o tym czy pisanie dokumentacji i kodowanie są do siebie podobne, czy kodujący Tech Writer ma jakieś dodatkowe umiejętności, dzięki którym jest w stanie dostarczać dokumentację lepszej jakości i czy dokumentacja mogłaby czerpać korzyści z testów, które są tworzone dla 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 like code", Anne Gentle:  https://www.docslikecode.com/book/
  • "Docs as code", Write the Docs:  https://www.writethedocs.org/guide/docs-as-code/
  • "#39 DITA as code, czyli klasyczny standard w nowoczesnym wydaniu", Tech Writer koduje: https://techwriterkoduje.pl/blog/2022/02/14/dita-as-code
  • Standard DITA (Darwin Information Typing Architecture): https://en.wikipedia.org/wiki/Darwin_Information_Typing_Architecture
  • Oxygen XML: https://www.oxygenxml.com/#bidx-xml-author
  • IntelliJ IDEA: https://www.jetbrains.com/idea/
  • Microsoft Word: https://www.microsoft.com/pl-pl/microsoft-365/word
  • "Programowanie imperatywne oraz deklaratywne", Codenga: https://codenga.pl/artykuly/poradniki/programowanie-imperatywne-oraz-deklaratywne
  • React: https://pl.reactjs.org/
  • Programowanie obiektowe: https://pl.wikipedia.org/wiki/Programowanie_obiektowe
  • Docusaurus: https://docusaurus.io/
  • Behavior-driven development (BDD): https://pl.wikipedia.org/wiki/Behavior-driven_development
  • Cucumber: https://cucumber.io/
  • "Rodzaje testów oprogramowania", Testerzy.pl: https://testerzy.pl/baza-wiedzy/artykuly/rodzaje-testow-oprogramowania
  • Test-driven development (TDD): https://pl.wikipedia.org/wiki/Test-driven_development
  • Foobar: https://pl.wikipedia.org/wiki/Foobar
  • Nuxt: https://nuxtjs.org/
    • ...more
    View all episodesView all episodes
    Download on the App Store
    Tech Writer KodujeBy Michał Skowron i Paweł Kowaluk