Wiki style (no signatures/approvals) documentation of complex software projects (lines of code > 10K) has the following benefits:
- Wiki approach saves you from wasting time in publication and approval process. It enables quick updates which increases quality of content.
- You as the developer will be able to remember important details of design, especially if long time has passed since you last worked on it.
- You can hand-off the project to junior developers without wasting your time.
- You can easily extract a user manual from existing content and users won't bother you with questions.
- Code reviewers get a better idea of overall design which increases the quality of review comments.
No comments:
Post a Comment