Documentation

17 views
Skip to first unread message

Tom Carchrae

unread,
Dec 15, 2011, 5:59:51 AM12/15/11
to cambridge...@googlegroups.com
> PS: My immediate goal is to come up with a better documentation. I really
> would appreciate if anyone can recommend me some tools to write a nicely
> structured documentation for the library.

I really like the tutorial format of

Objectify (thanks Jeff) -
http://code.google.com/p/objectify-appengine/wiki/IntroductionToObjectify

and

Play! - http://www.playframework.org/documentation/1.2.4/home

But there are different goals in documentation. Both of those
examples are great because they help get you up to speed and show you
exactly how to use it. Some documentation (actually far too much)
goes into excruciating detail and give you code snippits that don't
even compile and no idea of how to tie it altogether. Full working
downloadable examples with lots of comments are awesome (especially
self-contained ones that don't use maven!).

Reply all
Reply to author
Forward
0 new messages