Reference Implementation

So far, we have only described the first pillar of Effective Analysis—the theoretical principles and techniques. We have presented the practices we believe should be applied and those that should be avoided to accelerate analysis and documentation efforts. Although most advice was complemented with real-world examples, it was still just theory.

All theory, dear friend, is grey, but the golden tree of life springs ever green.

– Johann Wolfgang von Goethe

In this part, we will take the principles introduced in Part II and demonstrate how to implement them using a specific CASE tool and wiki software.
Nevertheless, as previously mentioned, CASE and wiki tools are not enough. To get the best of both worlds, information must be synchronized between the tools, which requires deploying "middleware" to automate the process. For that reason, an essential part of Effective Analysis is our custom-developed solution, which is also presented in this part.

So we have the principles and the solution. Although this combination alone would increase the effectiveness of analysis and documentation efforts, we decided to go one step further. In addition to presenting the principles and tools, we would also like to demonstrate how to apply them in the real world. This is why we went ahead and added supporting materials, such as artifact templates and repository structure examples, to provide teams with a ready-to-use framework. We believe that with such an all-in-one package, teams can start implementing the basics very quickly and then tailor the approach to their specific requirements and needs.