3 ms·
A downside of using a wiki for documenting software is that it can easily get out of sync with code. If your readme files and/or inline docs* are under version
by drewda 14y ago
A downside of using a wiki for documenting software is that it can easily get out of sync with code. If your readme files and/or inline docs* are under version control, each commit can include both code and doc changes.
* If your software is exposing an API to others in your company, you might want to look at Javadoc and other languages' equivalents: http://en.wikipedia.org/wiki/Javadoc http://en.wikipedia.org/wiki/Javadoc