#67 Tech Writer żegna
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 dominik-braun.net, udostępnianej na podstawie licencji Creative Commons license CC BY 4.0 (creativecommons.org/license...).
Informacje dodatkowe:
- "Never Use Foo, Bar, Baz, etc. in Software Documentation", Tech Your Chance: www.techyourchance.com/neve...
- "Online resources to learn how to code", StackOverflow Developer Survey 2022: survey.stackoverflow.co/202...
- "Online resources to learn how to code", StackOverflow Developer Survey 2023: survey.stackoverflow.co/202...
- "Default behaviour sticks (And so do examples)", Thinkst Thoughts: blog.thinkst.com/2023/08/de...
- "Code blocks", Docusaurus: docusaurus.io/docs/markdown...
- rundoc: eclecticiq.github.io/rundoc/
- "Code samples", Google developer documentation style guide: developers.google.com/style...
- "Creating sample code", Google Technical Writing: developers.google.com/tech-...
- "Guidelines for writing code examples", MDN: developer.mozilla.org/en-US...
- "Write excellent code examples", The Developer Advocacy Handbook: developer-advocacy.com/writ...
- Dokumentacja React.js: react.dev/
- Dokumentacja Yarn: yarnpkg.com/
- Dokumentacja react-router: reactrouter.com/en/main
- Prism.js: prismjs.com/
- Docusaurus: docusaurus.io/
- Storybook: storybook.js.org/
