Project #1 - Code Analysis OCD

Version 1.0,
Due Date: 12:00 am, Sunday, Wk2

Purpose:

This project requires you to develop an architectural concept for a Code Maintainability Analyzer. Requirements for that project focus on support for quality analysis of C# programs, and are given in the Project #2 Statement.
Your concept should explore:

Requirements:

  1. Shall be prepared as a Microsoft Office Word file or PDF file, using embedded gliffy Diagrams3.
  2. Shall explore and describe the user interface(s) you will provide.
  3. Shall partition processing into at least the top-level packages.
  4. Shall describe the uses/responsibilities, activities, events, and interactions of each of the packages in your concept.
  5. Shall use both text and diagrams for the descriptions in 4, above.
  6. Shall document any prototype code you develop in an Appendix. You don't need to include source code in your OCD document, but you do need to discuss the design of the prototypes. Please include your source code in the zip file used to submit your project for grading.

  1. In C# a package is a single file that has a prologue, consisting of comments that describe the package and its operations, one or more class implementations, and a test stub main function that serves as a construction test while building the package.
  2. You may use any office suite you prefer like Microsoft office, LibreOffice, or WPS. Please use gliffy for diagramming. It is available as a free chrome app. You will need to use the Chrome browser to install that.

What you need to know:

In order to successfully meet these requirements you will need to know:
  1. The definition of the term package and have looked carefully at a few examples.
  2. How to draw package and activity diagrams.
  3. How to organize and prepare a technical document. Here's some help.