1 CS Tutorial 3 Frid. Oct 9 th, 2009 Architecture Document Tutorial Questions & Examples

2 Tutorial Outline Answer any questions related to the architecture document Review some architecture document examples

3 Questions ???

4 Examples

5 Abstract Example: “This document discusses the architectural details of a scheduling system that we plan on building using Microsoft.NET framework. The system will be used by companies that provide maintenance and technical support for their products and/or services. The system will be used by three types of clients: customers, trades people, and administrators. The customers will put requests into the system. The trades people will view their schedules using the system. The administrators have the authority to make changes to the system. The system will use a scheduling algorithm to create servicing schedules for trades people based on customers requests. This report outlines the various subsystems and modules that make up the N-tier architecture of the web application and discusses the advantages of using such architecture. This report also examines the methodology and cost of implementing the system, the risks, evolvability, and feasibility of the system. The design document and the actual implementation will base on the information found in this document.”

6 Introduction Example: “The purpose of this report is to document the architecture of the software our group is proposing. Our software is an online multiplayer turn-based strategy game. This report will outline different aspects of our game, concentrating on the structure, architecture, performance and other aspects of the system. … (Explains the organization of the paper)” Still have no idea what the project is about!

7 Architecture Example 1: “As a whole, the system operates with a Client-Server model, and both the client and the server applications utilize an object-oriented design approach.” What do the arrows mean?? Good, includes figure number.. Could have a better figure title

8 Architecture Cont’d Example 2: “The clients-server style is at work by having the server host the web application and the clients access the system through any web browser. We choose to deploy our entire system in the server tier and a very thin client because this allows the widest range of clients to connect to our system.” What do the arrows mean?? No Figure number or title ?? Is this the server architecture only??

9 Use Cases Example 1: Good idea to show exceptions

Use Cases cont’d Example 2: 10 Could include authors

11 Methodology A table format is easier to understand.

12 Reminders The architecture document is due on Tuesday Oct. 13 th at the beginning of class.  I will pass by 5 min after the start of class to collect the documents (any document which is not submitted then will be considered late!) Please also me a soft copy with the following subject line (or something similar):  CS446: Group # Architecture Document Do not forget to include your group number on the title page of your document.

Next Tutorial… Don’t forget to check if your group is scheduled for Tuesday or Thursday! Go over prototype requirements. Come prepared with your prototype idea for discussion. 13