How to write better documentation: architecture, internal vs. external docs, and more cover art

How to write better documentation: architecture, internal vs. external docs, and more

How to write better documentation: architecture, internal vs. external docs, and more

Listen for free

View show details

About this listen

#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

What listeners say about How to write better documentation: architecture, internal vs. external docs, and more

Average Customer Ratings

Reviews - Please select the tabs below to change the source of reviews.

In the spirit of reconciliation, Audible acknowledges the Traditional Custodians of country throughout Australia and their connections to land, sea and community. We pay our respect to their elders past and present and extend that respect to all Aboriginal and Torres Strait Islander peoples today.