17
19 Comments

What's your fav tool to create user docs?

How do you create your user docs?

I've been using MkDocs.

It's pretty good. Easy to setup. Feels fluid when using it.

I'm using a custom theme that makes the output look a bit like some of the docs you see on Stripe, Twilio, etc.

Have been thinking about releasing the theme, if there's any interest.

What are you using? And how do you find it?

posted to Icon for group Developers
Developers
on February 15, 2021
  1. 5

    I'm in love with https://docusaurus.io
    I'm about to use it for both Blog and Self Support / Docs on https://hostedstatus.page

    1. 1

      Wow. Looks great. Says V2 is expanding beyond just user docs (i.e. build any website) hopefully that won't over complicate. Will try the tutorials. Thanks!

      1. 2

        +1 to docusaurus! I didn't think the ability to "build any website" complicated things, luckily. I built the site for https://sapling.dev/ with docusaurus...

        1. docs were easy to create
        2. blog is easy to create
        3. flexibility made it easy to write react for the home page, pricing page, and "code sample"

        I blogged about it here https://medium.com/javascript-in-plain-english/10-reasons-to-use-docusaurus-for-your-docs-blog-marketing-site-48dbf2c58b70

        1. 2

          Trying out Docusaurus now. I think my post could have been called Why wouldn't you use Docusaurus? as the results look so good.

          This maybe for purists:

          I like that Docusaurus provides even more flexibility, there’s something that bugs me about using React for a static site.
          https://www.stevemar.net/five-things-about-mkdocs/

          You site looks great btw. Maybe consider slightly larger font and center-align your cards (PostgreSQL etc) but just nit-picking :)

  2. 4

    At hookdeck.io we started with https://docusaurus.io but along with our new content strategy we ended up rolling our own which is fully compatible with docusaurus .md files. The main reason is that we wanted to support different layouts for different pieces of content like the API reference and the platform guides. I'm getting a little annoyed with having a bunch of different static generator for the blog, api ref, product docs, guide etc so built it under one roof.

    You can see the result here: https://hookdeck.io/docs. It took a little over 3 days to build (we already had the content written, we just migrated it over).

    I'm considering open sourcing it once I've got the time. If you like what you see, upvote or comment and I'll link a the Github repo once I get to it!

    It's in NextJS + StyledComponents. The API Ref and docs content is stored within the repo as markdown files and the articles (Platforms + other upcoming sections) are pulled as markdown from Contentful (Headless CMS). Developers commit product changes directly to the repo, writers and editors just have to publish on the CMS and don't need access / use the source.

    1. 3

      Looks solid! Nice work.

  3. 3

    For User Doc, we simply use... Intercom.
    Quite a good platform to publish clean/clear data. Easy to format - code extracts, screenshots, etc.

    Benefit is to be able to track in Intercom how users consume the documentation - when and how. Also quite easy to prompt users dynamically to the right part of the documentation.

  4. 3

    I use gitbook.com for API docs. It is excellent. However, it seems to have stopped development about a year ago...and least as far as the release notes go.

    1. 1

      Mad if it has stopped, as so well known!

      1. 1

        I agree. I hope they are still active. Looking at the change log is seems to have stopped new dev. https://blog.gitbook.com/changelog

  5. 1

    If you're using Notion as a core tool in your business, you might love doing user docs with: https://engine.so

    Engine turns Notion pages into public docs for your customers. This means you get the convenience of writing in Notion, and can also make it convenient for your customers to browse and consume this information on your website.

    If you're a business and serious about docs, I recommend giving it a try. You might find it really convenient.

  6. 1

    I've been using docsify, it's great -> https://docsify.js.org/#/
    you just need to add some javascript and can write your docs with markdown files.

  7. 1

    We use redoc for API docs & mkdocs-material (which is a highly maintained, awesome docs generator) for all other docs. Except for MDX support which could be great (in mkdocs in general) mkdocs-material is awesome and took minutes to set up and deploy to netlify for free.

    If you want a taste of what this can look with relatively minimal effort (aside for written content), here are our docs and API docs

  8. 1

    For user docs we built https://versoly.com/help.

    Uses the same fonts, colors, navbar and footer as your actually site (I hate when I use docs and can't navigate back to the main site). Also better for SEO as it is in a subfolder.

    In the near future there will be custom themes that you can "install" in one click.

  9. 1

    just started test-driving pinpoint; i know the team well.

  10. 1

    We've been using Notion and Super.so. We have a documentation staging area, and then just drag the page to the area when it's ready to go. It's been great because my non-technical co-founder can easily publish documentation.

    Some downsides:

    • Miss out on functionality of API docs (e.g., trying requests, etc.)
    • You have to manually set user friendly URLs in Super.so
    • Limited layout support, e.g., you can't have a floating sidebar table of contents
  11. 1

    I'm currently using Redoc for NDAify's API docs since I maintain an OpenAPI spec for it.

    I'm also using openapi-snippet to generate code examples, and if the user is logged in, inject their API_KEY for better DX.

    It's open source on GitHub:

    https://github.com/NDAify/ndaify-web/blob/master/src/pages/dev/docs.js

    Docusaurus didn't have an OpenAPI plugin when I built this so I should probably take another look.

    1. 1

      Thanks. Redoc looks good feature-wise, but could do with a bit more finesse on the css to reach the bar set by Docusaurus, imo.

Trending on Indie Hackers
I spent $0 on marketing and got 1,200 website visitors - Here's my exact playbook User Avatar 58 comments Veo 3.1 vs Sora 2: AI Video Generation in 2025 🎬🤖 User Avatar 28 comments Codenhack Beta — Full Access + Referral User Avatar 21 comments I built eSIMKitStore — helping travelers stay online with instant QR-based eSIMs 🌍 User Avatar 20 comments 🚀 Get Your Brand Featured on FaceSeek User Avatar 18 comments Day 6 - Slow days as a solo founder User Avatar 16 comments