chance-nelson / Team_Documents

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Cover Page Copypaste

Table of Contents Generate

Intro 1-2p Alex

  • Recycle previous
  • Motivate
  • Overview user-level, functional/performance, environmental reqs
    • 2nd half should be condensed reqs doc

Implementation Overview 1p Austin

  • Big picture technologies
  • Solution vision
  • Overall approach
    • Frameworks/techniques and what they contribute

Architectural Overview 2p Austin/Chance (part 1, part 2)

  • Part 1:
    • Architectural diagram of system's high-level architecture
      • Most important components
  • Part 2:
    • Discussion of architecture
      • Key responsibilities/features of each component
      • Main communication mechanisms/information control flows
      • Influences of 1+ architectural styles embodied by this architecture

Module and Interface Descriptions 6-8p Chance/Turan discuss which modules to split up and do, or split up by task inside modules (one does descriptions other does UML)

For each module:

  • English description of component and how it fits into the architecture
  • UML diagram of classes involved in component (or appropriate sub-program diagram)
  • Description of the public interface
    • "Explicitly outlines the services that the component provides"
    • Forr OOP this means public methods and their types/parameters

Implementation Plan 1-2p Turan

  • Design-centric implementation timeline
  • Gantt chart
    • Each module and associated testing and integration
  • Narrate major Gantt chart points/phases
    • Mention anything not graphically visible
  • Roughly divide tasks to members
    • Either in Gantt chart, in a simple table, or in the narrative

conclusion ½-1 Alex

  • Big picture value
  • Summarize document
  • How it contributes positively to project outcome

About