Hi, I’m writing a quite large documentation, and I’m getting a bit annoyed at writing HTML for everything.
So what I wonder is: Do you know a good language for writing documentation?
Benefits? Drawbacks?
This is an archived forum and the content is probably no longer relevant, but is provided here for posterity.
The active forums are here.
July 31, 2009 3:12pm
Subscribe [4]#1 / Jul 31, 2009 3:12pm
Hi, I’m writing a quite large documentation, and I’m getting a bit annoyed at writing HTML for everything.
So what I wonder is: Do you know a good language for writing documentation?
Benefits? Drawbacks?
#2 / Aug 01, 2009 1:50pm
I have heard good things about docbook. But it seemed overly complex to me so never really learned how to use it. I also read phpdocumentor can create documentation in docbook format but again haven’t used it.
#3 / Aug 02, 2009 12:07pm
wikimedia might work good for this
#4 / Aug 02, 2009 12:22pm
I like dokuwiki:
DokuWiki is a standards compliant, simple to use Wiki, mainly aimed at creating documentation of any kind. It is targeted at developer teams, workgroups and small companies. It has a simple but powerful syntax which makes sure the datafiles remain readable outside the Wiki and eases the creation of structured texts
#5 / Aug 03, 2009 10:23am
markdown I suppose.
pros : lots of places use it.
cons : the syntax sucks
#6 / Aug 03, 2009 10:56am
Of course you could also use a knowledge base system for writing the documentation. 😊 http://68kb.com
#7 / Aug 03, 2009 11:37am
I would like something with good syntax (which, as you stated, Markdown is lacking).
I also like to be able to generate static HTML pages, to be able to easily distribute an offline version of the manual.
#8 / Aug 03, 2009 11:32pm
You know this is something I am also wanting to do but I want to keep my html files in svn.
However I had some time tonight to run a test and came up with this:
http://68kb.com/124894/how-do-i-create-a-php-info-page.html
All of those are static html files generated from articles inserted using 68kb. I also tried to keep it close to the CI project documentation but keeping some sort of easy to use navigation.
At any rate if you love it or hate it let me know. I thought something like this opens up a lot of possibilities.
#9 / Aug 06, 2009 7:57am
Why not use yaml and then simply process it?