How to Create Great Documentation Podcast Por  capa

How to Create Great Documentation

How to Create Great Documentation

Ouça grátis

Ver detalhes do programa

Sobre este áudio

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.

O que os ouvintes dizem sobre How to Create Great Documentation

Nota média dos ouvintes. Apenas ouvintes que tiverem escutado o título podem escrever avaliações.

Avaliações - Selecione as abas abaixo para mudar a fonte das avaliações.