Home > Articles > Software Development & Management > Architecture and Design

  • Print
  • + Share This
This chapter is from the book

9.3 Two Examples

This section provides two examples of applying the procedure in the previous section to select a set of views for a project.

9.3.1 A Small Project: A-7E

The U.S. Navy's A-7E avionics program, used as a source for some of the documentation examples in this book, was one of the first software engineering projects that paid special attention to engineering and documenting its architecture as a set of related but separate views. It was by most standards a small project, with staff size of ten or less for most of its duration. Here are A-7E architecture views under the three-step method outlined above.

Step 1: Produce a Candidate View List

Stakeholders include the current and future architects, the project manager, members of the development team, testers and integraters, and maintainers. The architecture was designed to deliver three primary qualities: modifiability, real-time performance, and the ability to be fielded in incremental subsets. Hence, it is important to analyze the architecture for these qualities, and so by extension, the analysts become stakeholders. The agency responsible for funding the project was also a stakeholder; their interest was in knowing how the architecture leads to a system more maintainable than other avionics programs of the same generation.

Applicable views in the module viewtype include the decomposition, uses, and layered views. Generalization is not employed in the A-7E architecture. The system is structured as a set of cooperating sequential processes, and so in the C&C realm the communicating-processes view applies. The system also has a central data store called a Data Banker; its function is to isolate producers and consumers of data from each other to enhance modifiability. Therefore, the shared-data C&C view also applies. In the allocation viewtype, the work assignment, implementation, and deployment view, all apply as well.

Table 9.2 shows the stakeholders for the A-7E architecture documentation and the views useful to each. At this point, the candidate view list contains eight views.

Table 9.2: A-7E stakeholders and the architecture documentation they might find most useful

table 9.2

Step 2: Combine Views

The A-7E's hardware environment features a uniprocessor, and so the deployment view can be dispensed with. By adopting modules (as defined in the module decomposition view) as the basic unit of work assignment and development file structure, the work assignment and implementation views can easily be combined with the decomposition view. These simple decisions quickly eliminate three of the eight views from the candidate list.

Consultations with stakeholders revealed that the shared-data view was unnecessary. Performance analysts can build performance and schedulability models using the _communicating-processes view. Developers, testers, integraters, and maintainers can do their jobs with the module decomposition view1 (which tells them what the systems' parts were) and the layered view (which tells them what those parts are allowed to use).tight correspondence between modules and work assignments in this project, the creation of a module is also the commissioning of a work assignment. Before that work assignment can be carried out, the programmers need to know what other software they are allowed to use. Hence, the module decomposition and layered views proceeded hand in hand through successively finer levels of detail.

Communicating-processes views are created once the modules are decomposed to a sufficiently fine grain so that the communication and synchronization needs can be decided and then documented.

The uses view has the lowest priority, targeted for documentation only during the module implementation phase. The allowed-to-use information of the layered view constrains programmers but still leaves them with considerable latitude. As a trivial example, a programmer writing a "double(x)" routine is allowed to use multiplication (2x) or addition (x+x) to implement that function. The uses view reflects the programmers' actual choices. Since the uses view is not employed until it is time to begin fielding subsets, it is the last A-7E view to emerge.

9.3.2 A Large Project: ECS

ECS is a system for capturing, storing, distributing, processing, and making available extremely high volumes of data from a constellation of earth-observing satellites. By any measure, ECS is a very large project. Many hundreds of people are involved in its design, development, deployment, sustainment, and use. Here is how the three-step view selection approach might have turned out, had it been applied to the ECS software architecture.

Step 1: Produce a Candidate View List

Stakeholders for the ECS architecture include the usual suspects: the current and future architect, developers, testers and integraters, and maintainers. But the size and complexity of ECS, plus the fact that it is a government system whose development is assigned to a team of contractors, add complicating factors. In this case, there is not one project manager, but several: one for the government, and one for each of the contractors. Each contractor organization has its own assigned part of the system to develop, and hence, its own team of developers and testers. ECS relies heavily on COTS components so the people responsible for selecting COTS candidate components, qualifying them, selecting the winners, and integrating them into the system play a major role. We'll call these stakeholders COTS engineers.

The important quality attributes for ECS begin with performance. Data must be ingested into the system to keep up with the rate at which it floods in from the satellites. Processing the raw data into more sophisticated and complex "data products" must also be done every day to stay ahead of the flow. Finally, requests from the science community for data and data analysis must be handled in a timely fashion. Data integrity, security, and availability round out the important list of quality at-_tributes and make the analysts concerned with these qualities important architectural stakeholders.

ECS is a highly visible and highly funded project which attracts oversight attention. The funding authorities require at least overview insight into the architecture to make sure the money over which they have control is being spent wisely. Finally, the science community using ECS to measure and predict global climate change also require insight into how the system works, so they can better set their expectations about its capabilities.

At least five of the component-and-connector views discussed in Chapter 4 and all four of the module views of Chapter 2 apply to ECS. It is primarily a shared-data system. Its components interact in both client-server and peer-to-peer fashion. Many of those components are communicating _processes. And while the system is not actually built using pipes and filters, the pipe-and-filter style is a very useful _paradigm to provide an overview to some of the stakeholders. (Information more detailed than the overview will be in a different view, becoming an implementation refinement of the pipe-and-filter view.)

In addition to the five C&C views, all four of the module views discussed in Chapter 2 apply to ECS, as do all three of the allocation views discussed in Chapter 5.

Table 9.3 shows the stakeholders for the ECS architecture documentation and the views useful to each. At this point, the candidate view list contains 12 views.

Table 9.3: ECS stakeholders and architecture documentation they might find most useful.

table 9.3

Step 2: Combine Views

Because of the large size of this project and the number of different development organizations involved, the work assignment view (normally a good candidate for combination) would likely be kept separate. Similarly, because a large number of stakeholders interested in the module decomposition would not be interested in how the modules were allocated to files in the development environment, the implementation view would also be kept separate.

Three of the C&C views would prove good candidates for combination. Augmenting the shared-data view with other components and connectors that interact in client-server or peer-to-peer fashion allows those three views to become one. The pipe-and-filter view can be discarded; the shared-data view plus some key behavioral traces showing the data pipeline from satellite to scientist would provide the same intuitive overview to the less detail-oriented stakeholders.

Finally, recording uses information as a property of the decomposition view yields a combination of the decomposition and uses views.

After this step, eight views remain:

  • In the module viewtype, decomposition, layered, and generalization

  • In the C&C viewtype, shared-data and communicating-processes

  • In the allocation viewtype, deployment, implementation, and work assignment.

Step 3: Prioritize

To let the project begin to make progress requires putting contracts in place, which in turn requires coarse-grained decomposition. Thus, the higher levels of the decomposition and work assignment views would likely receive the highest priority.

FOR MORE INFORMATION

An excerpt from the A-7E module decomposition view is given in Section 2.1.

In ECS, the layering in the architecture is very coarse-grained and can be quickly described. Similarly, generalization occurs largely in only one of the three major subsystems, is also coarse-grained, and can also be quickly described. Hence, these two views might be given next priority because they can be quickly dispatched.

The shared-data, communicating-processes, and deployment views would follow, nailing down details of runtime interaction only hinted at by the module-based views. During this phase, the architect can see if the communicating processes map straightforwardly to components in the shared-data view, in which case those two views could also be combined.

Finally, because the implementation view can be relegated to each contractor's own internal development effort, it would receive the lowest priority from the point of view of the overall system.

The result is four "full-fledged" views (decomposition, work assignment, shared-data/communicating-processes, and deployment), and three minor ones that stop at high levels or can be deferred.

  • + Share This
  • 🔖 Save To Your Account

InformIT Promotional Mailings & Special Offers

I would like to receive exclusive offers and hear about products from InformIT and its family of brands. I can unsubscribe at any time.

Overview


Pearson Education, Inc., 221 River Street, Hoboken, New Jersey 07030, (Pearson) presents this site to provide information about products and services that can be purchased through this site.

This privacy notice provides an overview of our commitment to privacy and describes how we collect, protect, use and share personal information collected through this site. Please note that other Pearson websites and online products and services have their own separate privacy policies.

Collection and Use of Information


To conduct business and deliver products and services, Pearson collects and uses personal information in several ways in connection with this site, including:

Questions and Inquiries

For inquiries and questions, we collect the inquiry or question, together with name, contact details (email address, phone number and mailing address) and any other additional information voluntarily submitted to us through a Contact Us form or an email. We use this information to address the inquiry and respond to the question.

Online Store

For orders and purchases placed through our online store on this site, we collect order details, name, institution name and address (if applicable), email address, phone number, shipping and billing addresses, credit/debit card information, shipping options and any instructions. We use this information to complete transactions, fulfill orders, communicate with individuals placing orders or visiting the online store, and for related purposes.

Surveys

Pearson may offer opportunities to provide feedback or participate in surveys, including surveys evaluating Pearson products, services or sites. Participation is voluntary. Pearson collects information requested in the survey questions and uses the information to evaluate, support, maintain and improve products, services or sites, develop new products and services, conduct educational research and for other purposes specified in the survey.

Contests and Drawings

Occasionally, we may sponsor a contest or drawing. Participation is optional. Pearson collects name, contact information and other information specified on the entry form for the contest or drawing to conduct the contest or drawing. Pearson may collect additional personal information from the winners of a contest or drawing in order to award the prize and for tax reporting purposes, as required by law.

Newsletters

If you have elected to receive email newsletters or promotional mailings and special offers but want to unsubscribe, simply email information@informit.com.

Service Announcements

On rare occasions it is necessary to send out a strictly service related announcement. For instance, if our service is temporarily suspended for maintenance we might send users an email. Generally, users may not opt-out of these communications, though they can deactivate their account information. However, these communications are not promotional in nature.

Customer Service

We communicate with users on a regular basis to provide requested services and in regard to issues relating to their account we reply via email or phone in accordance with the users' wishes when a user submits their information through our Contact Us form.

Other Collection and Use of Information


Application and System Logs

Pearson automatically collects log data to help ensure the delivery, availability and security of this site. Log data may include technical information about how a user or visitor connected to this site, such as browser type, type of computer/device, operating system, internet service provider and IP address. We use this information for support purposes and to monitor the health of the site, identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents and appropriately scale computing resources.

Web Analytics

Pearson may use third party web trend analytical services, including Google Analytics, to collect visitor information, such as IP addresses, browser types, referring pages, pages visited and time spent on a particular site. While these analytical services collect and report information on an anonymous basis, they may use cookies to gather web trend information. The information gathered may enable Pearson (but not the third party web trend services) to link information with application and system log data. Pearson uses this information for system administration and to identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents, appropriately scale computing resources and otherwise support and deliver this site and its services.

Cookies and Related Technologies

This site uses cookies and similar technologies to personalize content, measure traffic patterns, control security, track use and access of information on this site, and provide interest-based messages and advertising. Users can manage and block the use of cookies through their browser. Disabling or blocking certain cookies may limit the functionality of this site.

Do Not Track

This site currently does not respond to Do Not Track signals.

Security


Pearson uses appropriate physical, administrative and technical security measures to protect personal information from unauthorized access, use and disclosure.

Children


This site is not directed to children under the age of 13.

Marketing


Pearson may send or direct marketing communications to users, provided that

  • Pearson will not use personal information collected or processed as a K-12 school service provider for the purpose of directed or targeted advertising.
  • Such marketing is consistent with applicable law and Pearson's legal obligations.
  • Pearson will not knowingly direct or send marketing communications to an individual who has expressed a preference not to receive marketing.
  • Where required by applicable law, express or implied consent to marketing exists and has not been withdrawn.

Pearson may provide personal information to a third party service provider on a restricted basis to provide marketing solely on behalf of Pearson or an affiliate or customer for whom Pearson is a service provider. Marketing preferences may be changed at any time.

Correcting/Updating Personal Information


If a user's personally identifiable information changes (such as your postal address or email address), we provide a way to correct or update that user's personal data provided to us. This can be done on the Account page. If a user no longer desires our service and desires to delete his or her account, please contact us at customer-service@informit.com and we will process the deletion of a user's account.

Choice/Opt-out


Users can always make an informed choice as to whether they should proceed with certain services offered by InformIT. If you choose to remove yourself from our mailing list(s) simply visit the following page and uncheck any communication you no longer want to receive: www.informit.com/u.aspx.

Sale of Personal Information


Pearson does not rent or sell personal information in exchange for any payment of money.

While Pearson does not sell personal information, as defined in Nevada law, Nevada residents may email a request for no sale of their personal information to NevadaDesignatedRequest@pearson.com.

Supplemental Privacy Statement for California Residents


California residents should read our Supplemental privacy statement for California residents in conjunction with this Privacy Notice. The Supplemental privacy statement for California residents explains Pearson's commitment to comply with California law and applies to personal information of California residents collected in connection with this site and the Services.

Sharing and Disclosure


Pearson may disclose personal information, as follows:

  • As required by law.
  • With the consent of the individual (or their parent, if the individual is a minor)
  • In response to a subpoena, court order or legal process, to the extent permitted or required by law
  • To protect the security and safety of individuals, data, assets and systems, consistent with applicable law
  • In connection the sale, joint venture or other transfer of some or all of its company or assets, subject to the provisions of this Privacy Notice
  • To investigate or address actual or suspected fraud or other illegal activities
  • To exercise its legal rights, including enforcement of the Terms of Use for this site or another contract
  • To affiliated Pearson companies and other companies and organizations who perform work for Pearson and are obligated to protect the privacy of personal information consistent with this Privacy Notice
  • To a school, organization, company or government agency, where Pearson collects or processes the personal information in a school setting or on behalf of such organization, company or government agency.

Links


This web site contains links to other sites. Please be aware that we are not responsible for the privacy practices of such other sites. We encourage our users to be aware when they leave our site and to read the privacy statements of each and every web site that collects Personal Information. This privacy statement applies solely to information collected by this web site.

Requests and Contact


Please contact us about this Privacy Notice or if you have any requests or questions relating to the privacy of your personal information.

Changes to this Privacy Notice


We may revise this Privacy Notice through an updated posting. We will identify the effective date of the revision in the posting. Often, updates are made to provide greater clarity or to comply with changes in regulatory requirements. If the updates involve material changes to the collection, protection, use or disclosure of Personal Information, Pearson will provide notice of the change through a conspicuous notice on this site or other appropriate way. Continued use of the site after the effective date of a posted revision evidences acceptance. Please contact us if you have questions or concerns about the Privacy Notice or any objection to any revisions.

Last Update: November 17, 2020