April 18, 2019

Any good public documentation tools?

Anyone have experience working with public documentation tools?

I'm writing out some docs for my dev tool and just need something clean and simple. No bells and whistles.

Haven't found any good options out there

  1. 2

    What was lacking in the options you found?

  2. 1

    Pretty big fan of gitbook. It's for books but can used for for docs or changelogs just the same

  3. 1

    VuePress is a nice option the lets you write Markdown and then kicks out a static site: https://vuepress.vuejs.org/

  4. 1

    RAML is fantastic for REST API documentation. Basically it's, higher level and less repetitive than Swagger.

    For programs, I like inline docs that includes doctests (forcing them to stay in sync with the code). For something extensive, try Gitbook.

  5. 1

    Depends on what kind of documentation. I use react styleguidist for frontend components, docsify for general documentation. Both very clean, simple and straightforward, if they fit your project. For APIs I would use some other specialized API documentation tool.