Tech Writer Koduje

#67 Tech Writer żegna "foo", "bar" i "baz", czyli jak tworzyć dobre próbki kodu

Listen Later

Próbki kodu to kluczowy element dokumentacji, a w szczególności dokumentacji dla deweloperów. Dlatego uważamy, że "foo", "bar" i "baz" muszą odejść.

Jako kodujący Tech Writerzy spotykamy się zarówno z dobrymi jak i kiepskimi przykładami, dlatego postanowiliśmy podsumować naszą wiedzę i doświadczenia w tym zakresie i zastanowić się jak tworzyć próbki, które są pomocne i łatwe do zrozumienia.

Rozmawiamy o dobrych i złych praktykach, o potencjalnych problemach i rozwiązaniach oraz, oczywiście, o narzędziach, które możemy wykorzystać, żeby nasze próbki były jeszcze lepsze.

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:

  • "Never Use Foo, Bar, Baz, etc. in Software Documentation", Tech Your Chance: https://www.techyourchance.com/never-use-foo-bar-baz/
  • "Online resources to learn how to code", StackOverflow Developer Survey 2022: https://survey.stackoverflow.co/2022/#section-learning-to-code-online-resources-to-learn-how-to-code
  • "Online resources to learn how to code", StackOverflow Developer Survey 2023: https://survey.stackoverflow.co/2023/#section-learning-to-code-online-resources-to-learn-how-to-code
  • "Default behaviour sticks (And so do examples)", Thinkst Thoughts: https://blog.thinkst.com/2023/08/default-behaviour-sticks-and-so-do-examples.html
  • "Code blocks", Docusaurus: https://docusaurus.io/docs/markdown-features/code-blocks
  • rundoc: https://eclecticiq.github.io/rundoc/
  • "Code samples", Google developer documentation style guide: https://developers.google.com/style/code-samples
  • "Creating sample code", Google Technical Writing: https://developers.google.com/tech-writing/two/sample-code
  • "Guidelines for writing code examples", MDN: https://developer.mozilla.org/en-US/docs/MDN/Writing_guidelines/Writing_style_guide/Code_style_guide
  • "Write excellent code examples", The Developer Advocacy Handbook: https://developer-advocacy.com/write-excellent-code-examples
  • Dokumentacja React.js: https://react.dev/
  • Dokumentacja Yarn: https://yarnpkg.com/
  • Dokumentacja react-router: https://reactrouter.com/en/main
  • Prism.js: https://prismjs.com/
  • Docusaurus: https://docusaurus.io/
  • Storybook: https://storybook.js.org/
    • ...more
    View all episodesView all episodes
    Download on the App Store
    Tech Writer KodujeBy Michał Skowron i Paweł Kowaluk