Thursday, June 23, 2022

Benefits of wiki style documentation

Wiki style (no signatures/approvals) documentation of complex software projects (lines of code > 10K) has the following benefits:

  1. Wiki approach saves you from wasting time in publication and approval process. It enables quick updates which increases quality of content.
  2. 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.
  3. You can hand-off the project to junior developers without wasting your time.
  4. You can easily extract a user manual from existing content and users won't bother you with questions.
  5. Code reviewers get a better idea of overall design which increases the quality of review comments.

No comments:

Post a Comment