Description
It’s easy to overlook documentation when building an application, but documentation can make or break a consumer’s experience. Today we’re diving into the world of documentation to discuss what it takes to write good documentation, the ethics of documentation, and some popular tools you can use to get started.
Show Notes
[01:58] Why does a company or app need good documentation?
[04:09] Who do we write documentation for?
[06:01] What makes good documentation?
[11:05] Ethics of documentation
[32:47] The structure of your documentation
[34:35] What types of documentation should I write?
[40:22] Documentation tools
[44:51] Shoutouts
Resources
Alex.js
Carolyn’s talk
Self Defined
Hemingway
Bookstack
Storybook
Writing Technical Documentation video
Notion
Nuclino
Docusaurus
Next.js
Nuxt.js
Gatsby
Jekyll
Transcript
Here is this week's transcript.
What is a typical day in the life like for a software engineer? To close out Season 6, we thought it’d be a great idea to give you some insight into our workdays, as we all have very different roles and are in different stages of our careers.
Show Notes
[02:54] Morning routines
[16:09]...
Published 10/04/21
APIs are part of our daily roles as software developers, but what are they? What different types are there? And how can you design a good one?
Show Notes
[01:53] What is an API?
[03:37] Types of APIS
[15:02] GraphQL
[19:49] REST
[28:25] API Design
[44:35] Shoutouts
Resources
The Happiness...
Published 09/27/21