Artwork

Content provided by Kristian Freeman. All podcast content including episodes, graphics, and podcast descriptions are uploaded and provided directly by Kristian Freeman or their podcast platform partner. If you believe someone is using your copyrighted work without your permission, you can follow the process outlined here https://player.fm/legal.
Player FM - Podcast App
Go offline with the Player FM app!

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

19:14
 
Share
 

Manage episode 386547189 series 3511933
Content provided by Kristian Freeman. All podcast content including episodes, graphics, and podcast descriptions are uploaded and provided directly by Kristian Freeman or their podcast platform partner. If you believe someone is using your copyrighted work without your permission, you can follow the process outlined here https://player.fm/legal.

#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

  continue reading

10 episodes

Artwork
iconShare
 
Manage episode 386547189 series 3511933
Content provided by Kristian Freeman. All podcast content including episodes, graphics, and podcast descriptions are uploaded and provided directly by Kristian Freeman or their podcast platform partner. If you believe someone is using your copyrighted work without your permission, you can follow the process outlined here https://player.fm/legal.

#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

  continue reading

10 episodes

All episodes

×
 
Loading …

Welcome to Player FM!

Player FM is scanning the web for high-quality podcasts for you to enjoy right now. It's the best podcast app and works on Android, iPhone, and the web. Signup to sync subscriptions across devices.

 

Quick Reference Guide