Friday, May 29, 2015

Best Practices of Reviewing Architecture/Design Documents

What is the best practice of reviewing design documents and for that matter any technical word documents like Architecture, High Level, Low Level design documents?

There are two aspect of it.

1) Review comments statistics should be produced at the end of the show
2) Review comments should be specific, which can be tracked.


To support these two aspects, generally people do either of these two:

1) Capture comments in the word documents using the MS word insert comment feature. Using insert comment allows to capture both text and part of a diagram.
2) Capture the comments in a tracker spreadsheet



Both of them has pros and cons as follows

1) Capture comments in the word documents using the MS word insert comment feature



Pros: For technical people who is working on the comments and addressing the comments it is very search to locate the comments and get the specific context of the comment.

Cons: Difficult to support management showing the count of the comments, the severity of the comments, who had worked on which comments, which comments are closed and which are open. Makes the document itself messy.

2) Capture the comments in a tracker spreadsheet

Pros: Gives a clear statistics for management view as discussed above.

Cons: Does not give a precise context of the comment. 

Suggestions:

Do both of them. Have a template spreadsheet to capture the comments to show the management. This will be very helpful to support your own case if you are working as an author of the document or reworking on the document for closure.

No comments:

Post a Comment