Welcome Guest, Not a member yet? Register   Sign In
what is the best workflow to write documntation ?
#7

[eluser]m4rw3r[/eluser]
If you want something more rigid and standardized, look at DocBook.

It is XML based and contains a huge set of tags for different purposes. The large number of tags may seem daunting at first, but it gets easier once you've learned the basic ones (one downside is that you will probably have to search for the correct tag sometimes).

Styling it should be quite straightforward, but it will be harder to change the HTML structure as it uses a XSLT stylesheet to convert the xml to html (or PDF, man pages, whatever).

If you want to take a look at a project I've written which uses docbook, look at RapidDataMapper. The xml sources are in doc/manual/src.


Messages In This Thread
what is the best workflow to write documntation ? - by El Forum - 01-02-2010, 01:51 PM
what is the best workflow to write documntation ? - by El Forum - 01-02-2010, 02:35 PM
what is the best workflow to write documntation ? - by El Forum - 01-02-2010, 04:54 PM
what is the best workflow to write documntation ? - by El Forum - 01-02-2010, 05:07 PM
what is the best workflow to write documntation ? - by El Forum - 01-02-2010, 10:53 PM
what is the best workflow to write documntation ? - by El Forum - 01-03-2010, 01:56 PM
what is the best workflow to write documntation ? - by El Forum - 01-04-2010, 04:33 PM
what is the best workflow to write documntation ? - by El Forum - 01-05-2010, 10:17 AM
what is the best workflow to write documntation ? - by El Forum - 01-06-2010, 08:41 AM



Theme © iAndrew 2016 - Forum software by © MyBB