software technical review for decision makers

Question

Problem: I have to write a review discussing the technical aspects of two competing software system (Document management systems). I have to review scalability, availability, maintainability, usability, extensibility, cost, and other relevant aspects.

Question: Is there a template or preferred method you have for writing this kind of document where the audience is both technical people, and non-technical managers?

Answer 1

I would structure it as:

1. Executive Summary (what this document is, overview, short-conclusion)
2. Objectives (To review two competing systems)
3. SystemA
   a) FeatureA (Why we need it, technical rundown, pros, cons) b) FeatureB ....
4. SystemB
   a) FeatureA ...
5. Business Case for A - (Cost, ROI, Possible problems, Case studies)
6. Business Case for B - (Cost, ROI, Possible problems, Case studies)
7. Functional Comparison of A vs B
8. Operational Comparison (running costs, stability, long-term updates ...)
9. Conclusion/Recommendation
10. References - Important

This way, people can read the "feature" sections containing technical and managerial information and then make an informed decision. Alternatively, you include your conclusion and recommendation too. If consensus is reached then great.

Just make sure it is structured, concise and ordered by relevancy to the decision maker. Maybe create a technically-ordered version and a manager's version. Some people won't read the whole thing and you need to ensure the summary has weight for each reader-type.