I’m using the Wiki that’s built into the GitHub service for the BitBuilder Game Platform documentation. GitHub’s Wiki is full-featured, easy to use, and plugged right in next to the source downloads and commit history.
For any open source project to succeed, it needs serious and quality documentation. This is where most open source projects fail and it’s an area that I want to put a lot of focus on with BitBuilder. Since it’s a wiki, anyone can help out, and you don’t need to be a programmer to do so. In fact, it might even be better if you’re not as you’ll have a unique perspective trying to get things running.
My goals for the wiki are to have serious technical specifications for each facet of BitBuilder, but more importantly a series of great, simple walkthroughs to get you up and running, building your game quickly no matter what type of game it is (platformer, puzzle, rpg, adventure, shooter, etc.)
When it comes to documentation, what do you look for? What do you need from documentation? What do you hate about documentation? What makes one project’s documentation better than another?
