Skip to content

Commit

Permalink
[bug#5][WIP] created 05-documentation.md, seeded with initial content.
Browse files Browse the repository at this point in the history
  • Loading branch information
svaksha committed Oct 1, 2014
1 parent 4c9d9e4 commit fb0c267
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions notes/05-documentation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Documentation

Software programmers and developers like to write code but writing "documentation" for their code is considered a chore. This is easily discernable on the most popular code hosting service - Github, which has tons of open source software repo's but only a fraction of these are well-documented. The downside? Thanks to the lack of proper documentation within their codebase, many Free/Open Source Software (FOSS) projects struggle to find new contributors.

Lets say, a user wants to fix a bug but writing the code patch and testing it isnt enough. Inaddition to fixing the bug, she has to wade through your complex codebase to figure out what each function, class or module does. That seems quite unreasonable given that volunteers are after-all unpaid contributors who are trying to help fix things.


### Tools
- [Doxygen](http://www.stack.nl/~dimitri/doxygen/index.html)

### Online free services
- [ReadTheDocs](https://readthedocs.org/)

0 comments on commit fb0c267

Please sign in to comment.