How do you guys knock up SAAS documentation?
I thought a discussion around product documentation could be interesting?
Personally I’m looking for a HTML template, preferably bootstrap 4.
I thought a discussion around product documentation could be interesting?
Personally I’m looking for a HTML template, preferably bootstrap 4.
We decided to go with gitbook. Ther was an alternate stoplight. Both are similar but i prefer gitbook due to its seamless editing experience.
Keep docs in markdown on github, use static site generators like Gatsby. That way you’re independent from CMS/HTML and current design trends and it’s easy to give your docs a facelift when they start to look outdated
I used Slate in the past and it's really great to setup a nice documentation à la Stripe :)
Hey, have a look at https://www.gitbook.com/
Free version, dead simple, clean interface. At first I thought like you, making an Html template and so on, but in the end my advice would be to focus on content rather than design. Great documentation design can come when you are at a Stripe level ;-) (and even Stripe has a gitbookish design for its docs)
Perfect, thank you. What's your experience like with the free version - does it allow you to stick your own logo on there and use a custom domain? From the pricing page, it looks like you can, though it states in the docs that custom domain is paid feature?
Sure you can, customizing will be limited but you can add your logo and redirect to subdomain (like https://support.mailmeteor.com, live soon)
Nice - you've really helped me out, thank you!
Hi @colaba, a few days ago I've told you that we were setting up a documentation with Gitbook. It's now released, so that you get a better idea of what is possible with the tool : https://support.mailmeteor.com/
Cheers!
Ah, that looks really slick! Thanks for taking the time to come back and share your results. Have you had any feedback from users etc?
Hey @colaba, sure, we've noticed a decrease in support and it's definitely easier to help our users with detailed articles. Writing documentation can be time-consuming but it pays in the end. I'd say we spent 10-15 hours to write this documentation for Mailmeteor.
Finding Gitbook was amazing. It was pure chance coming across them after googling and researching open-source + paid docs solutions for an hour.
The product is super slick, from the editor, to real-time updates, to the Git-like commit structure, to the modern visual look/feel. Really blows everything else out of the water. The 3-column permalink structure and API blocks sealed the deal. It has elegant versioning, analytics -- ahh, I'm just a big fan of their product.
We're currently hosting our technical docs on Gitbook, but I can see us eventually migrating everything from our Knowledge Base, etc to Gitbook.