News for hackers. Stuff that matters.
Re:WTFM - Write The Freaking Manual by fellars on Friday September 28, 2012 @09:00AM (#4585254)
Any pointers on how to make it easier to wtfm? If anyone out there actually enjoys writing documentation I'd be willing to pay for some help and guidance on a rather large commercial open source project that is in need of some tlc regarding documentation
Re:WTFM - Write The Freaking Manual by takluyver on Friday September 28, 2012 @09:26AM (#4585347)
In the Python world, readthedocs.org has made writing docs easier - it takes care of rebuilding documentation each time you commit. It's implemented in Python, and most popular with the Python community, but it can be used for other languages as well.
Re:WTFM - Write The Freaking Manual by qznc on Friday September 28, 2012 @09:23AM (#4585339)
Sphinx is pretty nice, even if it is not a python project.

http://sphinx.pocoo.org/

Re:WTFM - Write The Freaking Manual by tsahyt on Friday September 28, 2012 @09:15AM (#4585305)
API documentation can be generated from the source code with tools like doxygen. For everything else there's the standard toolchain consisting of a good editor and source control. Writing documentation is a chore but it's a very important aspect nevertheless.
Re:WTFM - Write The Freaking Manual by FiddlerClamp on Friday September 28, 2012 @09:30AM (#4585365)
I'm a marketing and technical writer - take a look at the URL in my profile and get in touch if you are interested.