Jump to content
  • Advertisement
Sign in to follow this  
qCring

What are you using for creating devdocs?

This topic is 2738 days old which is more than the 365 day threshold we allow for new replies. Please post a new topic.

If you intended to correct an error in the post then please contact us.

Recommended Posts

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!

Share this post


Link to post
Share on other sites
Advertisement
We use a mix of Doxygen for automatic generation and Confluence for the stuff that needs manual editing all the time.

Share this post


Link to post
Share on other sites
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.

Share this post


Link to post
Share on other sites
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.

Share this post


Link to post
Share on other sites
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.

Share this post


Link to post
Share on other sites
Epydoc for actual code documentation: http://epydoc.sourceforge.net/

Mediawiki for the rest of the project documentation: http://www.mediawiki.org/wiki/MediaWiki/

Share this post


Link to post
Share on other sites
Sign in to follow this  

  • Advertisement
×

Important Information

By using GameDev.net, you agree to our community Guidelines, Terms of Use, and Privacy Policy.

We are the game development community.

Whether you are an indie, hobbyist, AAA developer, or just trying to learn, GameDev.net is the place for you to learn, share, and connect with the games industry. Learn more About Us or sign up!

Sign me up!