MBASE Project Deliverables for CSCI577a

Guidelines [Best Printed in Landscape]

Updated on Oct. 5, 2003. If you have any questions, please send e-mail to zhihaoch@usc.edu:

Grading criteria:

One point will be deducted if you break one of the following guidelines one time.

For example, if you have two WS_FTP.LOG files, you will lost two points.

Storing Project Deliverables for CSCI577a

To receive their midterm project grades and final project grades, the team must follow the following guidelines:

General Directory Structure for TeamXXa:

Store project deliverables in the directory structure shown under "General Directory Structure for TeamXXa" above.
For a hypothetical team - TeamXXa, XX means the number of the team like 01, 02, 03 ...
In every file name, F03 means Fall 2003
All stuff in this structure should be accessible through the web by the public.
Everything in the structure must have at least one URL in a HTML page in the structure.
All directories / sub-directories should be accessible through FTP by the CSE instructional staff through the read and execute permissions must be put at the "group".level
"......" in each directory means you can put additional files/directories if they are needed.
Please make sure to use exactly the same capitalization in the names, since as you know, UNIX is case-sensitive!
Use ONLY relative links. For example, use "LCO/OCD_LCO_F03a_T19.doc" instead of "http://www-scf.usc.edu/~csci577/teams/team19a/LCO/OCD_LCO_F03a_T19.doc" in your home page.
If your prototype absolutely requires absolute references, document those in a readme.txt file.
If you generate subdirectories other than the ones listed below, generate a "readme.txt" file explaining the contents of those various directories
If you have more than one file for the one artifact, you can create a directory to store them or you can compress them as a zip file. For example, you can create /OCD/ in LCO or LCA, store additional files including index.html that belong to the Operational Concept Description (OCD).
If an artifact is not applicable to your project, include the name of the not-applicable files with the rationale in the file called "readme.txt".
Try to put the image files and other files needed for the home page with the tools like FrontPage that often generate such files with a leading "_" into a sub directory with a name "images" in that current directory, or a same directory "images".
For each file, please at least fill the author section of the file properties with the last author of the document.
UML Model Files (Rose) should be kept in synchronization with documentation.
Documentation of the prototype (including screen shots if needed) should be kept in synch with the live prototype.
Hyperlinking the various documents enforces traceability and consistency checking
- E.g., documentation should be a hyperlink instead of duplicating the same information
- Instead of just having a 'Refer to OCD 2.3', try to add a link to the target section (in this case, OCD2.3)
- For this purpose, you may need to add HTML anchors to link to a particular section in a big document
In addition, every team is required to set up a website which will give easy read-only access to the artifacts.
The team website should have at least the following basic information about the project, the team members (name and role), contact information (e-mail addresses ...) of team members and the clients, etc...
Teams can further enhance their website if desired
The team website should provide links to each of the artifacts.
You should also provide links to each index file.
Do not include any trash file like ~WRLxxxx.tmp, ~$D_As-built_F03a_T01.doc, WS_FTP.LOG ...
All final version files must can be accessed from the section or the index file of FinalDeliverables. If the document has not been changed from the last milestone before FinalDeliverables, just add a link pointing to the file in the previous milestone in the section or the index file of FinalDeliverables.
DO NOT DUPLICATE ANY FILE. If the file has not been changed between two milestones, add a link in the section or the index file of the latter one pointing to the file in the previous milestone. You also need to provide the rational for that.
All index files are optional except the one in the directory of TeamXXa. All readme.txt files are optional.
Do not include any empty file.
The rational for the missing files and the additional files must be carefully addressed.
The URL should point to a file not to a directory, for example, the URL for Progress Reports should be href="ProgressReports/index.html" instead of href="ProgressReports/".
Identify the following values for the project attributes and put into your project home page:

Academic_Period	CS577a Fall 2002	Customer
Project_Domain		Developers
Project_Name		Number_of_Developers
Project_Type		COTS
Team_Number

Project_Domain:

Multimedia Archive, Automated Reference Services and FAQ's, Interactive Communication and Distributed Browsing Application, COTS Package Extension, Selective Dissemination of Information, Data Analysis, Activity Monitoring and Control, Data Migration, Special Collection Access, Distributed Borrowing, Interactive Communication. ...

Here are the examples to help you how to determine your project belong to which domain.
Project_Name:

... (The name of the project)

Project_Type:

Database, Image Search, Web Based, Web Based Database, GUI, Web Mail, ...

Customer:

... (the name of the client and the contact information - e-mail, title, telephone ...)

Developers:

Students, ...

Number_of_Developers:

The number of team member in this project.

COTS:

Application-Intensive, Tailoring-Intensive, Assessment-Intensive, Others.

Here are the examples to help you how to determine your project belong to which type of COTS.

Team_Number:

TeamXXa

The guidelines still need to be improved. If you have any suggestions, please send e-mail to zhihaoch@usc.edu.

Detail Directory Structure for TeamXXa:

/TeamXXa/
          readme.txt ............. Include the name and rationale for any additional sub-directories or files.
                                          Only if needed, list the file names in current directory which are not applicable and give the rationales.

          index.html

         [Folder in /TeamXXa]
         /PR/ ..... Weekly Progress Reports
                  index.html          ........... index for progress reports
                  Week01_PR_F03a_TXX.doc ........... (.doc files for week 01)
                  Week01_PR_F03a_TXX.xls ........... (.xls files for week 01)
                  ......

         [Folder in /TeamXXa]
         /CMN/ .................. Client Meeting Notes (Including minutes and e-mails between the clients and the team)
                  index.html          ....... index for Client Meeting Notes
                  CMN_MM_DD_F03_TXX.doc         ....... Client Meeting Notes
                  CMN_MM_DD_F03_TXX.pdf         ....... Client Meeting Notes
                  ......

                  For example, for the client meeting note of team 01 on Oct 18, 2003:
                         CMN_10_18_F03_T01.doc         ....... Client Meeting Notes
                         CMN_10_18_F03_T01.pdf         ....... Client Meeting Notes

         [Folder in /TeamXXa]
         /LCO/ ..................
                  readme.txt ............. Include the name and rationale for any additional sub-directories or files.
                                                  Only if needed, list the file names in current directory which are not applicable and give the rationales.
                  OCD_LCO_F03a_TXX.doc ...................... Operational Concept Description
                  OCD_LCO_F03a_TXX.pdf ....................... Operational Concept Description
                  SSRD_LCO_F03a_TXX.doc ..................... System and Software Requirements Definition
                  SSRD_LCO_F03a_TXX.pdf ...................... System and Software Requirements Definition
                  SSAD_LCO_F03a_TXX.doc ..................... System and Software Architecture Description
                  SSAD_LCO_F03a_TXX.pdf ...................... System and Software Architecture Description
                  FRD_LCO_F03a_TXX.doc ........................Feasibility Rationale Document
                  FRD_LCO_F03a_TXX.pdf .........................Feasibility Rationale Document
                  LCP_LCO_F03a_TXX.doc ........................Life Cycle Plan
                  LCP_LCO_F03a_TXX.pdf ........................ Life Cycle Plan
                  UML_Model_LCO_F03a_TXX.mdl ......... Models (e.g., Rational Rose UML Model Files)
                  UML_Model_LCO_F03a_TXX.zip ......... Model file set (All the files that is related with Rational Rose UML Model Files)
                  ARB_Slides_LCO_F03a_TXX.ppt ............ Architecture Review Board Presentation
                  ARB_Slides_LCO_F03a_TXX.pdf ............ Architecture Review Board Presentation
                  ARB_Report_LCO_F03a_TXX.doc ......... Architecture Review Board Report
                  ARB_Report_LCO_F03a_TXX.pdf ........ . Architecture Review Board Report
                  EWW_LCO_F03a_TXX.doc .................... The result of Easy Winwin negotiation
                  EWW_LCO_F03a_TXX.pdf .....................The result of Easy Winwin negotiation
                  ......
　

                  [Folder in /TeamXXa/LCO]
                /QR/ .............. Quality Reports for artifacts
                            readme.txt ............. Include the name and rationale for any additional sub-directories or files.
                                                            Only if needed, list the file names in current directory which are not applicable and give the rationales.
                             index.html   ............ index for Quality Reports
                             OCD_LCO_QR_F03a_TXX.doc.................. Quality Report for OCD
                             SSRD_LCO_QR_F03a_TXX.doc................. Quality Report for SSRD
                             SSAD_LCO_QR_F03a_TXX.doc................. Quality Report for SSAD
                             LCP_LCO_QR_F03a_TXX.doc................... Quality Report for LCP
                             FRD_LCO_QR_F03a_TXX.doc................... Quality Report for FRD
                             UML_LCO_QR_F03a_TXX.xls................... Quality Report for UML
                             OCD_LCO_QR_F03a_TXX.xls................... Quality Report for OCD
                             SSRD_LCO_QR_F03a_TXX.xls.................. Quality Report for SSRD
                             SSAD_LCO_QR_F03a_TXX.xls................. Quality Report for SSAD
                             LCP_LCO_QR_F03a_TXX.xls................... Quality Report for LCP
                             FRD_LCO_QR_F03a_TXX.xls................... Quality Report for FRD
                             ......

                   [Folder in /TeamXXa/LCO]
                   /PMD/ ............ Property Model Data
                            readme.txt ............. Include the name and rationale for any additional sub-directories or files.
                                                            Only if needed, list the file names in current directory which are not applicable and give the rationales.
                            index.html          ....... index for Property Model Data

                            COCOMO_LCO_F03a_TXX.est........................... COCOMO Data (e.g., EST files)
                              COCOMO_LCO_F03a_TXX.rpt.......................... COCOMO Data (e.g., rpt files)
                               ......
　

                   [Folder in /TeamXXa/LCO]
                   /Prototypes/.....................
                            readme.txt ............. Include the name and rationale for any additional sub-directories or files.
                                                            Only if needed, list the file names in current directory which are not applicable and give the rationales.
                            index.html          ....... index for Prototypes

......

         [Folder in /TeamXXa]
         /LCA/ ..................
                  readme.txt ............. Include the name and rationale for any additional sub-directories or files.
                                                  Only if needed, list the file names in current directory which are not applicable and give the rationales.
                  OCD_LCA_F03a_TXX.doc ...................... Operational Concept Description
                  OCD_LCA_F03a_TXX.pdf ....................... Operational Concept Description
                  SSRD_LCA_F03a_TXX.doc ..................... System and Software Requirements Definition
                  SSRD_LCA_F03a_TXX.pdf ...................... System and Software Requirements Definition
                  SSAD_LCA_F03a_TXX.doc ..................... System and Software Architecture Description
                  SSAD_LCA_F03a_TXX.pdf ...................... System and Software Architecture Description
                  FRD_LCA_F03a_TXX.doc ........................Feasibility Rationale Document
                  FRD_LCA_F03a_TXX.pdf .........................Feasibility Rationale Document
                  LCP_LCA_F03a_TXX.doc ........................Life Cycle Plan
                  LCP_LCA_F03a_TXX.pdf ........................ Life Cycle Plan
                  UML_Model_LCA_F03a_TXX.mdl ......... Models (e.g., Rational Rose UML Model Files)
                  UML_Model_LCO_F03a_TXX.zip ......... Model file set (All the files that is related with Rational Rose UML Model Files)
                  ARB_Slides_LCA_F03a_TXX.ppt ............ Architecture Review Board Presentation
                  ARB_Slides_LCA_F03a_TXX.pdf ............ Architecture Review Board Presentation
                  ARB_Report_LCA_F03a_TXX.doc ......... Architecture Review Board Report
                  ARB_Report_LCA_F03a_TXX.pdf ........ . Architecture Review Board Report
                  EWW_LCA_F03a_TXX.doc .................... The result of Easy Winwin negotiation
                  EWW_LCA_F03a_TXX.pdf .....................The result of Easy Winwin negotiation
                  ......
　

                  [Folder in /TeamXXa/LCA]
                /QR/ .............. Quality Reports for artifacts
                            readme.txt ............. Include the name and rationale for any additional sub-directories or files.
                                                            Only if needed, list the file names in current directory which are not applicable and give the rationales.
                             index.html   ............ index for Quality Reports
                             OCD_LCA_QR_F03a_TXX.doc.................. Quality Report for OCD
                             SSRD_LCA_QR_F03a_TXX.doc................. Quality Report for SSRD
                             SSAD_LCA_QR_F03a_TXX.doc................. Quality Report for SSAD
                             LCP_LCA_QR_F03a_TXX.doc................... Quality Report for LCP
                             FRD_LCA_QR_F03a_TXX.doc................... Quality Report for FRD
                             UML_LCA_QR_F03a_TXX.xls................... Quality Report for UML
                             OCD_LCA_QR_F03a_TXX.xls................... Quality Report for OCD
                             SSRD_LCA_QR_F03a_TXX.xls.................. Quality Report for SSRD
                             SSAD_LCA_QR_F03a_TXX.xls................. Quality Report for SSAD
                             LCP_LCA_QR_F03a_TXX.xls................... Quality Report for LCP
                             FRD_LCA_QR_F03a_TXX.xls................... Quality Report for FRD
                             ......

                   [Folder in /TeamXXa/LCA]
                   /PMD/ ............ Property Model Data
                             readme.txt ............. Include the name and rationale for any additional sub-directories or files.
                                                            Only if needed, list the file names in current directory which are not applicable and give the rationales.
                            index.html          ....... index for Property Model Data

                            COCOMO_LCA_F03a_TXX.est........................... COCOMO Data (e.g., EST files)
                              COCOMO_LCA_F03a_TXX.rpt.......................... COCOMO Data (e.g., rpt files)
                               ......
　

                   [Folder in /TeamXXa/LCA]
                   /Prototypes/.....................
                             readme.txt ............. Include the name and rationale for any additional sub-directories or files.
                                                            Only if needed, list the file names in current directory which are not applicable and give the rationales.
                            index.html          ....... index for Prototypes

......

        [Folder in /TeamXXa]
        /FD/ ....................             If the final/latest version of a document does not already exist, put it in here.
                index.html          .......The index file must have the links to all final/latest version of the file of OCD, SSRD, SSAD, FRD, LCP, UML Model

readme.txt ............. Include the name and rationale for any additional sub-directories or files.
Only if needed, list the file names in current directory which do not have links and give the rationales