BROADCASTS.com

b'

"Docs like code" czy "Docs as code" to model tworzenia dokumentacji, kt\\xf3rego g\\u0142\\xf3wnym za\\u0142o\\u017ceniem jest traktowanie dokumentacji jak kodu pod k\\u0105tem proces\\xf3w oraz narz\\u0119dzi, kt\\xf3rych u\\u017cywamy do jej tworzenia. Jednak czy mo\\u017cna p\\xf3j\\u015b\\u0107 o krok dalej i rozszerzy\\u0107 za\\u0142o\\u017cenia tego modelu na sam proces pisania dokumentacji?

Rozmawiamy o tym czy pisanie dokumentacji i kodowanie s\\u0105 do siebie podobne, czy koduj\\u0105cy Tech Writer ma jakie\\u015b dodatkowe umiej\\u0119tno\\u015bci, dzi\\u0119ki kt\\xf3rym jest w stanie dostarcza\\u0107 dokumentacj\\u0119 lepszej jako\\u015bci i czy dokumentacja mog\\u0142aby czerpa\\u0107 korzy\\u015bci z test\\xf3w, kt\\xf3re s\\u0105 tworzone dla oprogramowania.

D\\u017awi\\u0119ki wykorzystane w audycji pochodz\\u0105 z kolekcji "107 Free Retro Game Sounds" dost\\u0119pnej na stronie https://dominik-braun.net, udost\\u0119pnianej na podstawie licencji Creative Commons license CC BY 4.0 (https://creativecommons.org/licenses/by/4.0/).

Informacje dodatkowe:

\\n
• "Docs like code", Anne Gentle:  https://www.docslikecode.com/book/
\\n
• "Docs as code", Write the Docs:  https://www.writethedocs.org/guide/docs-as-code/
\\n
• "#39 DITA as code, czyli klasyczny standard w nowoczesnym wydaniu", Tech Writer koduje: https://techwriterkoduje.pl/blog/2022/02/14/dita-as-code
\\n
• Standard DITA (Darwin Information Typing Architecture): https://en.wikipedia.org/wiki/Darwin_Information_Typing_Architecture
\\n
• Oxygen XML: https://www.oxygenxml.com/#bidx-xml-author
\\n
• IntelliJ IDEA: https://www.jetbrains.com/idea/
\\n
• Microsoft Word: https://www.microsoft.com/pl-pl/microsoft-365/word
\\n
• "Programowanie imperatywne oraz deklaratywne", Codenga: https://codenga.pl/artykuly/poradniki/programowanie-imperatywne-oraz-deklaratywne
\\n
• React: https://pl.reactjs.org/
\\n
• Programowanie obiektowe: https://pl.wikipedia.org/wiki/Programowanie_obiektowe
\\n
• Docusaurus: https://docusaurus.io/
\\n
• Behavior-driven development (BDD): https://pl.wikipedia.org/wiki/Behavior-driven_development
\\n
• Cucumber: https://cucumber.io/
\\n
• "Rodzaje test\\xf3w oprogramowania", Testerzy.pl: https://testerzy.pl/baza-wiedzy/artykuly/rodzaje-testow-oprogramowania
\\n
• Test-driven development (TDD): https://pl.wikipedia.org/wiki/Test-driven_development
\\n
• Foobar: https://pl.wikipedia.org/wiki/Foobar
\\n
• Nuxt: https://nuxtjs.org/
\\n