How to write better documentation: architecture, internal vs. external docs, and more
7.dev Podcast with Kristian Freeman11/29/23 • 19 min
#10: In this episode, Kristian covers writing better documentation. While developers aren't always the best docs writers (sorry!), with a few tricks and best practices covered in this episode, you can learn how to write better docs, identify what docs your product is missing, and more.
Links mentioned in this episode:
Divio Documentation System: https://documentation.divio.com/
- JQuery: https://jquery.com/
- HTML: https://html.spec.whatwg.org/
- CSS: https://www.w3schools.com/css/css_intro.asp
- DOM: https://dom.spec.whatwg.org/
- React: https://react.dev/
- Vue: https://vuejs.org/
- Cloudflare: https://www.cloudflare.com/
- Node: https://nodejs.org/en/
- Next: https://nextjs.org/
- HTMX 7.dev Blog: https://7.dev/getting-started-with-htmx/
Connect with 7.dev:
7.dev: https://links.7.dev (links to all social media, new free courses, and more)
Kristian Freeman: Twitter
11/29/23 • 19 min
Generate a badge
Get a badge for your website that links back to this episode
<a href="https://goodpods.com/podcasts/7dev-podcast-with-kristian-freeman-280613/how-to-write-better-documentation-architecture-internal-vs-external-do-37991731"> <img src="https://storage.googleapis.com/goodpods-images-bucket/badges/generic-badge-1.svg" alt="listen to how to write better documentation: architecture, internal vs. external docs, and more on goodpods" style="width: 225px" /> </a>
Copy