Hello everyone!
I´m using very basic handwritten HTML code to create my project documentation.. it´s doing it´s job well but I realize I´m spending most time with rearranging, organizing and rewriting code for every little change in my document.. and that´s pretty ugly.. I´m also missing some dynamic stuff to improve navigation and overview... it would be nice to have some features like they can be found
here
for example..
I thought it wouldn´t be a big deal to write text and include some images.. but there´s so much unnecessary work.. typing all the crappy html-code and messing around with aaaall the files... -_-
As you see, I´m not very familiar with the whole subject so I thought it would be the best to learn from the professionals ;) enlighten me!
Adios!
What are you using for creating devdocs?
We use a mix of Doxygen for automatic generation and Confluence for the stuff that needs manual editing all the time.
Many projects out there in vacuumland use Docbook to generate both print and online documentation.
It is a nightmare, but pretty much the de facto standard for open source stuff.
It is a nightmare, but pretty much the de facto standard for open source stuff.
Writing apidocs by hand is generally not a good idea, unless the api is _static_ ( such as OpenGL which didn't change until recently for nearly 20 years ). Instead you can sed/grep the source files to autogenerate simple documentation. If you want more then sed can give you, or you don't like sed, you probably should use doxygen or a similar tool ( i'm not a guru of it but i think with sufficient pimping you can get it to generate msdn-styled output ) unless you literaly want to reinvent the wheel.
Game development is highly iterative so a wiki of some kind is pretty close to ideal for most stuff. We use confluence here quite a bit.
Epydoc for actual code documentation: http://epydoc.sourceforge.net/
Mediawiki for the rest of the project documentation: http://www.mediawiki.org/wiki/MediaWiki/
Mediawiki for the rest of the project documentation: http://www.mediawiki.org/wiki/MediaWiki/
This topic is closed to new replies.
Advertisement
Popular Topics
Advertisement