Super User is a question and answer site for computer enthusiasts and power users. It's 100% free, no registration required.

Sign up
Here's how it works:
  1. Anybody can ask a question
  2. Anybody can answer
  3. The best answers are voted up and rise to the top

I am writing a help file for a product and I need the help file to be searchable.

The help file can be HTML, PDF, DOC, etc., but I need a way to search, list and bring the user to the relevant page. I am going to be writing many tiny pages, snippets and variations of other snippets; Essentially just a lot of text to make the help file searchable and useful.

I haven't seen any help file that works well. As in: I can ask it a question and it will bring up relevant results.

What program/product can I use to make a searchable help file? The solution must work on Windows, Mac and Linux.

share|improve this question

You can try Sphinx. The excellent Python help file and online documentation is generated with Sphinx, and is very search-friendly.

You can also generate other formats including PDF, EPub and man.

share|improve this answer

Your Answer


By posting your answer, you agree to the privacy policy and terms of service.

Not the answer you're looking for? Browse other questions tagged or ask your own question.