Git Product home page Git Product logo

course's Introduction

Title Subtitle Author
Documenting and Understanding Software Systems
CRN 2366{2,3,4} - SENG 480A/CSC485A/CSC578B - A01
Neil Ernst

Schedule and Topics - Spring 2017

The following schedule is subject to change, and will change.

Class Topics Other Resources Readings Deadlines
Jan 4 Intro; introductions; Project outlined. What is Software Architecture? text chapter 1
Jan 8 Software arch overview. text chapter 2
Jan 11 Reading Code. chapter 3 text, source code of web crawler
Jan 15 Architecture Stakeholders and Requirements. Team kickoff text chapter 16 M0 due
Jan 18 More on Requirements and Scenarios โ€ข Project work
Jan 22 Views on Architecture - Modules text chapter 18 M1 due
Jan 25 Views part 2 - C&C SEI view example text chapter 4
Jan 29 Architecture and Design What is Architectural Design text chapter 17
Feb 1 Design cont. M2 due
Feb 5 Documenting behavior. Technical writing skills (30 mins) SEI behavior tech report
Feb 8 Mid-term project status updates. Exam notes.
Feb 11 assignment 1 due midnight
Feb 12 Reading Break
Feb 15 Reading Week
Feb 19 Group work in class - Omar leads
Feb 22 Class cancelled - Neil away M3 due
Feb 26 Midterm Midterm
Mar 1 Industry lecture - model driven development
Mar 5 API and Interface documentation. Interface documentation
Mar 8 Technical Debt and Metrics my Field Study of TD metrics and TD M4 due
Mar 12 Evaluating Docs Guidelines for AD reviews
Mar 15 Architecture analysis ch 21
Mar 19 Documenting Ops
Mar 22 Industry lecture - agile teams and architecture M5 due
Mar 26 Microservice styles; the latest research
Mar 29 Project presentations Groups 1,2,3,5
Apr 2 Stat Holiday
Apr 5 Project presentation Groups 4,6,7,8
Apr 6 M6 and M7 due in repo
Apr 10 No class Grad report due

Syllabus

Software is a long-lived and complex thing. This course is about understanding software in the large. We use the SEI text as a framework for understanding large-scale software systems. Topics include

  • what is architecture? Who are architects?
  • what structures are important to understand?
  • views on software systems
  • software quality attributes
  • architecture analysis and recovery
  • architecture-driven design
  • agile architecture
  • design, architecture, and technical debt

(the official course syllabus is distributed via HEAT (SENG480a link))

Required Text:

SEI Software Architecture in Practice, Len Bass, Paul Clements, Rick Kazman. 3rd Edition. 2013.

Other texts

  • Design It! From Programmer to Software Architect, by Michael Keeling, Pragmatic Programmers 2017.
  • Just Enough Software Architecture, by George Fairbanks, Marshall and Brainerd, 2010.
  • Documenting Software Architectures, by Paul Clements et al., Addison-Wesley, 2011.
  • Designing Software Architecture, A Practical Approach, by Humberto Cervantes and Rick Kazman, Addison-Wesley 2017.
  • Software Systems Architecture: Working with Stakeholders Using Viewpoints and Perspectives, by Nick Rosanski and Eoin Woods, Addison-Wesley, 2011.
  • Applied Software Architecture, Christine Hofmeister, Rod Nord, Dilip Soni, Addison-Wesley, 2000.
  • Essential Software Architecture, by Ian Gorton, Springer, 2011.
  • Software Architecture: Perspectives on an emerging discipline, Mary Shaw and David Garlan, Prentice-Hall, 1996.
  • Architecture of Open-Source Applications, Amy Brown and Greg Wilson, eds. http://aosabook.org

Past versions:

Instructors

  • Neil Ernst, instructor. Office ECS 560, office hours after class Thursday or DM me.
  • Omar Elazhary, teaching assistant

Course Overview

After the course, students are able to:

  • begin to reason about and evaluate software design tradeoffs
  • capture software architecture in modern documentation approaches
  • work together in teams, with modern software tools.
  • use a views and beyond approach to capture software architecture.
  • compare and contrast different architectural styles, including product lines, microservices, MVC.
  • explain and recognise technical debt.

Deliverables

The class will use Github and Slack to work on the project. Students will have to register their Github username (either a permanent one or a throwaway) with the instructors. Those with an objection to using Github please contact the instructor for workarounds. All Github activity is private to the class organization. Please see the privacy notice on the Connex site.

Slack will be the primary mechanism used for communication in the class. My rationale (apart from being tools used in practice) is to expose the class as a whole to questions about projects, assignment, and lectures.

University and department policies on professional conduct and integrity are applicable. Feel free to see me in person, or via UVic email, for personal questions.

Overview

There is one assignment, a midterm, and a substantial group project. Grad students have one extra assignment to conduct.

Assignment

Undergrads: One individual assignment worth 25% of final mark. Due dates as below.

  • for one of the projects in the course, pick a quality attribute, create a quality attribute scenario, and document how the project source code realizes this scenario. Provide discussion on how the project can handle changes in this scenario in the future.

Grads: the undergrad assignment, plus

  • a documentation review session on the student document, with report detailing how well the documentation has been completed (e.g., can we answer key stakeholder questions).

Group Project

The primary deliverable is a group project. You and your team will select a software project (OSS on Github), and document important views on the software. The end result will be a set of documentation about the software system and a deep understanding of how it is constructed. 60% of final mark. Students will be assigned to teams and document an open source software system. Due dates in calendar below. See the Project outline.

Midterm

One midterm, worth 15%. Tentatively scheduled for Feb 26.

Final

No final.

Resources

  1. Slack
  2. Github site
  3. Github help pages
  4. Github bootcamp

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.