6 ms·
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 r
by fellars 14y ago
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
- tsahyt 14y agoAPI 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.
- qznc 14y agoSphinx is pretty nice, even if it is not a python project. http://sphinx.pocoo.org/ http://sphinx.pocoo.org/
- takluyver 14y agoIn 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.
- FiddlerClamp 14y agoI'm a marketing and technical writer - take a look at the URL in my profile and get in touch if you are interested.