The TrackJS 1.0 documentation was terrible. It all started so simple–there wasn’t a lot in the beginning. But as we grew and handled more situations, our “one page” docs were becoming quite the tome. Worse, it was all on the “Getting Started”. We we’re intimidating customers by showing them 10,000 words just to get the system installed!
Building good documentation is not trivial. It must explain a complex system, which continues to change, and must be organized into small enough chunks to be searchable and digestible. It also must be easy to write, maintain, and deploy or it will surely get neglected.
Daux.io is an documentation generator that uses a simple folder structure and Markdown files to create custom documentation on the fly. It helps you create great looking documentation in a developer friendly way.
We chose Daux.io because:
- It looked polished out of the box
- Documentation written in markdown
- Write and manage it like source code
- We could easily deploy and host it on our existing infrastructure
Documentation is a differentiator. We launched ours a few weeks ago and I’m very pleased with the results. Our customer’s are doing more based on the examples. We’re getting fewer support requests; but when we get one, it’s clear they’ve already researched what’s happening. When we discover something unexpected, it’s easy for us to add more examples or clarification, reducing our future work.
Separating the documentation from the “Getting Started” page let us make this text as simple as possible. We want to help get you started fast, not crowd you out with options
Most importantly, I think the thorough explanations we’ve added to the documentation gives our customers more confidence in us. I wish we would have built this sooner.