Design – Build – Run: Applied Practices and Principles for Production-Ready Software Development

14.7. Logical Component Model

Figure 14-17 shows the first pass of the component model based on the information discussed in this chapter.

Figure 14.17. Figure 14-17

The figure doesn't show all the framework components, such as the web framework or the batch framework, but it captures all the high-level components discussed so far. You have a fair idea of what these need to do and which parameters and return values they should support. Ideally, you'd list out all the components and pull together the high-level component specifications for each of them. The high-level specifications actually provide the basis of the XML comments for the components. Once you're in a position to generate the documentation from the code, you could drop the original specs in favor of the generated documents. For the purposes of space and time, this will not be performed here.

As you can see from the logical component model, the architecture has been broken up considerably and has introduced a wide variety of different components and types. Although this might seem over-the-top for such a simple application, it demonstrates the method rather than the result. Only by performing these types of exercises can you gauge the true scope of the project.

The logical component model is another diagram that will be frequently referred to throughout the project, so it should contain as many components as possible. ...