DEV Community

Cover image for How to document like your life depends on it
Maxim Schepelin
Maxim Schepelin

Posted on

1 1

How to document like your life depends on it

A good overview of how to write documentation

  • Discussion about when and how to write documentation.
  • Pros and cons of specific tools: markdown, Atlassian confluence.
  • Good examples on how to measure the quality of the documentation.

Top comments (0)

Bump.sh

Hate writing docs?

Hate undocumented APIs even more?

Bump.sh generates an always up-to-date API reference site for REST and Event-Driven Architectures.

Plug it in your CI. It fetches your OpenAPI and AsyncAPI (GraphQL pending) spec files, and even generates a diff. Gather all of your API docs in a single source of truth.

Try it for free

👋 Kindness is contagious

Please leave a ❤️ or a friendly comment on this post if you found it helpful!

Okay