12/23/2023 0 Comments Documenting software architectures![]() ![]() ![]() ![]() Benefitsĭocumentation can help a software development organization avoid the pitfalls of inappropriate or incomplete or vague documentation. And it produces documentation that is compliant with Standards ISO/IEC 42010 and IEEE 1471-2000. It is notation, language, domain, and technology independent. V&B works in both Agile and traditional development settings. Documentation may be used to drive analysis, to constrain an implementation, to manage a project, or to convey an introductory overview of a system.ĭocumentation that applies across views follows a simple how-what-why approach: how the documentation is organized to serve stakeholders, what the architecture is, and why the architecture is the way it is (i.e., design rationale). A first step is to choose the relevant views, and this choice in turn depends on the anticipated usage. The more that documentation is treated as a follow-on to design, with its own separate method, the less likely it will be done at all.ĭocumenting a software architecture is a matter of documenting the relevant views, and then adding information that applies across views. It also helps the architect identify and record necessary design decisions during development.ĭocumentation should be the helpful result of making an architecture decision, not a separate step in the architecture process. V&B is more than an architecture documentation method. What notations are available for documenting an architecture, for documenting a view, for documenting an interface, for documenting behavior?.How do you specify an element's behavior?.What information beyond views must be recorded? What information applies to more than one view? How do you record the relationship among views?.How do you specify an architectural element's software interface? What information do you record?.What information do you record about an architectural view beyond just the graphical box-and-line diagram or "cartoon"?.How do you decide which architectural views to document?.How do you capture the software architecture for a system in a document that can successfully serve all of the architecture's stakeholders?.The basic principle of V&B is that documenting a software architecture involves documenting the relevant views, and then documenting the information that applies to more than one view. Views represent the many system structures that are present simultaneously in software systems. ![]() A view represents a set of system elements and the relations associated with them. The name emphasizes that we use the concept of a view as the fundamental organizing principle for architecture documentation. The SEI has a proven approach to documenting software architecture called Views and Beyond, or V&B. An architecture must be understood so that others-designers of finer grained components, implementers, testers, performance engineers, security analysts, builders of interfacing systems-can build systems from it, analyze it, maintain it, and learn from it. But communicating an architecture to its stakeholders is as important a job as creating it in the first place. Without an adequate architecture that delivers required function as well as quality attributes, the project will fail. A software system's architecture may be its most crucial determinant of success or failure. ![]()
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |