Guide to Making Documentation

Writing

Who is your audience?

  • https://twitter.com/dan_abramov/status/1083472984252260352

    Top two mistakes in documentation:

    • Assuming people know everything
    • Assuming people are stupid

What are people wanting to achieve?

Maintaining

Tools

Vuepress

npm version license monthly downloads github stars

Docusaurus

npm version license monthly downloads github stars

Docz

npm version license monthly downloads github stars

Syntax Highlighting

Highlight.js

Prism