Wednesday, October 24, 2007

Wikis and Documentation

I've identified some reasons why revision control is critical for source code:
  • Organizing concurrent development (branches) is error-prone and time-consuming.
  • Reverting code to prior versions is error-prone and time-consuming.
  • Identifying changes for a file is error-prone and time-consuming.
Am I missing something?

Should uncorrelated documentation be under revision control? I'm not referring to javadoc or any documentation that is explicitly tied to the source code. I'm referring to the documentation that accompanies a software project- code style guidelines, build procedures, review procedures, etc. Ideally, these documents should not be tied to any version of the software.
  • There is no need to support branching.
  • The only relevant version is the most recent one.
  • Identifying changes to historical versions has less value.
I think a WikiEngine is ideal for this sort of thing. I have little experience with utilizing a wiki for this purpose- so I'm wondering if anyone has a different take on the issue. Are wiki's too free-form for documentation? Fellow coders, please comment.

0 comments: