Ask HN: User Documentation solution?

3 points by martinbc 12y ago ↗ HN

I have to make a "microsite" under my application with documentation about it.

The concept must be very similar to any "programming project" style.. (codex.wordpress.org, guides.rubyonrails.org, docs.shopify.com/themes): I have to teach users how to do some tasks.

I started generating Markdown files and parsing them as html but I realized that the scope is a bit larger: I have to handle sidebar links, breadcrumb navs, translation support, etc)

Is there any tool/service/project for that? What is the best/common practice to solve it?

4 comments

[ 3.1 ms ] story [ 18.2 ms ] thread

johns 12y ago ↗

daux.io perhaps?

martinbc 12y ago ↗

I tested it but I would like to know alternatives because it requires PHP and my project is under Ruby.

swanson 12y ago ↗

You probably want to look at help desk SaaS apps. Or bite the bullet and roll your own - FYI you can just render Markdown directly pretty easily in Rails/Sinatra to avoid pasting HTML :)

Thanks for the recommendation, in fact I am doing it now :)