From: Intransition Date: 2010-03-26T21:48:33+09:00 Subject: Re: Ruby and user documentation On Mar 26, 4:15 am, Michel Demazure wrote: > Hi all, > > I just finished a quite large business project (in 1.9, pure ruby, not > Rails, with GUIs in FXRuby). I want to write a documentation for users > (not the code doc, I use Yard for it). Of course I can produce doc files > or PDF files. > > But I'd like to stay in the Ruby ecosystem.  What would do suggest ? > Prawn, Sinatra ... ? Do you know examples (with reusable patterns) ? I would use a markup language for the files, probably Markdown*. HTML is the "universal language" so that should be the end product. But you can also generate PDFs for print. You can always write pre- and post- processors for any specialized patterns you might need --indeed you might find that others have already done it for you. Also, if I may toot my own horn for a second, have a look at QED which would allow you to test your code examples directly. Another route, especially if your ultimate goal is printing a book, you might look into how the Pragmatic Programmers handle it --I think they use XML and their own DTD. *AsciiDoc is well regarded too, but it does lie outside the strict domain of Ruby tools.