-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[bug#5][WIP] created 05-documentation.md, seeded with initial content.
- Loading branch information
Showing
1 changed file
with
12 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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/) |