Wednesday, July 8, 2009

Upload design artifacts

I've uploaded most of the requirements gathering, analysis, and design artifacts created so far in this project.

Requirements Gathering was fairly easy, since I'm the user.

The documents are in the source code system; this allows me to update them from multiple locations (work, home, etc.).

The main piece of documentation is the "NyMPH Analysis Master.docx" file. This is a master document with a bunch of sub-documents linked internally. This document describes use case specifications, business rule specifications, and UI element specifications (which are mostly placeholders for items mentioned in the use cases).

There is also a "NyMPH TODO List.docx" file that contains a generalized development plan followed by a 'scratch list' of things to do. Many of them are crossed off but kept as reference.

Finally there is a "Domain Glossary.docx" file that defines many of the terms used in this project. For instance, it specifies what a 'Patch' is in terms of the Nord Modular system to help differentiate it from a Patch File (which is the *.pch file containing the Patch Data), Patch Data (which is the raw textual data that makes a patch), and so on.

I will be adding UML diagrams later as time allows. Note that my use of UML diagrams was to gain experience doing them, not necessarily thoroughly diagramming the NyMPH system. :) Not getting paid by the hour for this, so I've avoided over-diagramming the system.

No comments:

Post a Comment