Documentation Roadmap and Overview - SENG-350-2024-fall/Team-8 GitHub Wiki


Documentation Roadmap and Overview

Sub-parts of this section provide information that will help readers or users of the Software Architecture Document (SAD) quickly find information that will enable them to do their jobs. Readers of the SAD seeking an overview should begin here, as should readers interested in finding particular information to answer a specific question.

  • How the SAD is organized explains the information that is found in each section of the SAD.
  • How a view is documented explains how architectural views are documented in this SAD.

Purpose and Scope of the SAD

This document describes the architecture of the Mister Ed hospital triage application developed by Team 8 for the SENG 350 project at UVIC. Mister Ed is a javascript application containing 71 source files set up using React. A thorough description of Mister Ed can be found in the Wiki

This documents structure follows the Software Architecture Documentation Template and the Java Pet store document example provided by the instructor.

The architecture outlined in this document is based on our implementation of Mr.Ed and the instructions provided in the grading scheme an requirements for milestones for the SENG 350 project. The system architecture comprises of the structure of the software, the softwares elements and the relationship between these components.

How the SAD Is Organized

  • The Documentation Roadmap contains an overview of the entire document and a roadmap to other sections of the document.
  • Architecture Background offers an explanation regarding the background and rationale as well as the major architectural approaches used in developing the software.
  • Views The views depict different systems structures.
  • Mapping Between Views demonstrates how different views map to each other.
  • Referenced Materials List of outside documents referenced by the SAD
  • Glossary and Acronyms index of definitions of technical terms and architectural elements