Tululoo HTML5 Game Maker Designing Docs for Developers Last week we re-designed our documentation, primarily in terms of organization and content, but we also made the visual design fit in with our homepage. I decided to write about our experiences to get your feedback to inform future updates and also to share the recipe we came up with for designing docs for developers. What do you think of the results? How do you like to see docs organized and presented? 4 top-level categories3 questions the front-page must answerNo social features or promotional materials It’s a work in progress and we’d love your feedback. Here’s where we started from… The good news was that we knew the very basics of the content were sound – plenty of users are building on our platform using this content. But we could tell something needed to change since we were getting support requests that seemed to point to a difficulty finding the right information with this design. What we did Fewer top-level categories Visual design fitting in with homepage What we didn’t do Next steps
Booty5 free HTML5 Game Maker and Game Engine | Create HTML5 games and Flash Style Animations easily for free docco Docco is a quick-and-dirty, hundred-line-long, literate-programming-style documentation generator. It produces HTML that displays your comments alongside your code. Comments are passed through Markdown, and code is passed through Pygments syntax highlighting. This page is the result of running Docco against its own source file. If you install Docco, you can run it from the command-line: docco src/*.coffee ...will generate linked HTML documentation for the named source files, saving it into a docs folder. The source for Docco is available on GitHub, and released under the MIT license. To install Docco, first make sure you have Node.js, Pygments (install the latest dev version of Pygments from its Mercurial repo), and CoffeeScript. sudo npm install docco If Node.js doesn't run on your platform, or you'd prefer a more convenient package, get Rocco, the Ruby port that's available as a gem.