Software Architecture California State University 加利福尼亚州立大学软件体系结构.pptVIP

Documenting Software Architectures Outline Introduction Uses of Architectural Documentation Views Choosing the Relevant Views Documenting a View Documentation across Views Unified Modeling Language Summary Introduction The software architecture plays a central role in system development and the organization that produces it. It is a blueprint for both the system and the project developing it. It defines work assignments. It is the primary carrier of system qualities. It is the conceptual glue that holds every phase of the project together for all of its many stakeholders. Introduction (Cont’d) Documentation is the crowning step to crafting the architecture. It must be described in sufficient detail, without ambiguity, and organized so that all stakeholders can quickly find the information they need. Uses of Architectural Documentation Architecture documentation is both prescriptive and descriptive. It satisfies the different needs of different stakeholders. It probably consists of many different pieces, each oriented to a specific set of stakeholders. It helps to educate people new to the project. Stakeholders Who Use the Architectural Documentation Architect and requirements engineers who represent the customer(s) Architect and designers of constituent parts Implementors Testers and integrators Maintainers Designers of other systems with which this one must interoperate Stakeholders (Cont’d) Quality attribute specialists Managers Product line managers Quality assurance team Views There are many viewpoints for an architecture. Documenting an architecture is a matter of documenting the relevant views and then adding documentation that applies to more than one view. Choosing the Relevant Views Architects need to think about their software in at least three ways: How it is structured as a set of implementation units (module view) How it is structured as a set of elements that have runtime behavior and interactions (component-and-connector view) How it relates to no