Guidelines  [Best Printed in Landscape]

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

Grading criteria:

     One point will be deducted if you break any 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 CSCI577b

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

General Directory Structure for TeamXXb:

1. Store project deliverables in the directory structure shown under "General Directory Structure for TeamXXb" above.
2. For a hypothetical team - TeamXXb, XX means the number of the team like 01, 02, 03 ...
3. In every file name, S04 means Spring 2004
4. All stuff in this structure should be accessible through the web by the public.
5. Everything in the structure must have at least one URL in a HTML page in the structure.
6. 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
7. "......" in each directory means you can put additional files/directories if they are needed.
8. Please make sure to use exactly the same capitalization in the names, since as you know, UNIX is case-sensitive!
9. Use ONLY relative links. For example, use "LCO/OCD_LCO_S04b_T19.doc" instead of "http://www-scf.usc.edu/~csci577/teams/team19b/LCO/OCD_LCO_S04b_T19.doc" in your home page.
10. If your prototype absolutely requires absolute references, document those in a readme.txt file.
11. If you generate subdirectories other than the ones listed below, generate a "readme.txt" file explaining the contents of those various directories
12. 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).
13. 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".
14. 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".
15. For each file, please at least fill the author section of the file properties with the last author of the document.

                                    

     

16. UML Model Files (Rose) should be kept in synchronization with documentation.
17. Documentation of the prototype (including screen shots if needed) should be kept in synch with the live prototype.
18. Hyperlinking the various documents enforces traceability and consistency checking
    • E.g., documentation should 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
19. In addition, every team is required to set up a website which will give easy read-only access to the artifacts
20. 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...
21. Teams can further enhance their website if desired
22. The team website should provide links to each of the artifacts.
23. You should also provide links to each index files.
24. Do not include any trash file like ~WRLxxxx.tmp, ~$D_As-built_S04b_T01.doc, WS_FTP.LOG ...
25. 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.
26. 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.
27. All index files are optional except the one in the directory of TeamXXb. All readme.txt files are optional.
28. Do not include any empty file.
29. The rational for the missing files and the additional files must be carefully addressed.
30. 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/"
31. Identify the following values for the project attributes and put into your project home page:

• 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:

TeamXXb

The guidelines still need to be improved. If you have any suggestions, describe them in your individual critique.

Detail Directory Structure for TeamXX:

/TeamXXb/
          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 /TeamXXb]
         /PR/ ..... Weekly Progress Reports
                  index.html          ........... index for progress reports
                  Week01_PR_S04b_TXX.doc ........... (.doc files for week 01)
                  Week01_PR_S04b_TXX.xls ........... (.xls files for week 01)
                  ......
 

         [Folder in /TeamXXb]
         /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_S04_TXX.doc         ....... Client Meeting Notes
                  CMN_MM_DD_S04_TXX.pdf         ....... Client Meeting Notes
                  ......
 

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

         [Folder in /TeamXXb]
         /RLCA/ .................. Life-Cycle Objective 
                  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_RLCA_S04b_TXX.doc ...................... Operational Concept Description
                  OCD_RLCA_S04b_TXX.pdf ....................... Operational Concept Description
                  SSRD_RLCA_S04b_TXX.doc ..................... System and Software Requirements Definition
                  SSRD_RLCA_S04b_TXX.pdf ...................... System and Software Requirements Definition
                  SSAD_RLCA_S04b_TXX.doc ..................... System and Software Architecture Description
                  SSAD_RLCA_S04b_TXX.pdf ...................... System and Software Architecture Description
                  FRD_RLCA_S04b_TXX.doc ........................Feasibility Rationale Document
                  FRD_RLCA_S04b_TXX.pdf .........................Feasibility Rationale Document
                  LCP_RLCA_S04b_TXX.doc ........................Life Cycle Plan
                  LCP_RLCA_S04b_TXX.pdf ........................ Life Cycle Plan
                  UML_Model_RLCA_S04b_TXX.mdl ......... Models (e.g., Rational Rose UML Model Files)  
                  UML_Model_RLCA_S04b_TXX.zip .........  Model file set (All the files that is related with Rational Rose UML Model Files)  
                  ARB_Slides_RLCA_S04b_TXX.ppt ............ Architecture Review Board Presentation
                  ARB_Slides_RLCA_S04b_TXX.pdf ............ Architecture Review Board Presentation
                  ARB_Report_RLCA_S04b_TXX.doc ......... Architecture Review Board Report
                  ARB_Report_RLCA_S04b_TXX.pdf ........ . Architecture Review Board Report
                  EWW_RLCA_S04b_TXX.doc .................... The result of Easy Winwin negotiation
                  EWW_RLCA_S04b_TXX.pdf .....................The result of Easy Winwin negotiation
                  ......
　

                  [Folder in /TeamXXb/RLCA]
                  /QR/ .............. Quality Reports for artifacts (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. 
                             index.html   ............  index for Quality Reports
                             OCD_RLCA_QR_S04b_TXX.doc.................. Quality Report for OCD
                             SSRD_RLCA_QR_S04b_TXX.doc................. Quality Report for SSRD
                             SSAD_RLCA_QR_S04b_TXX.doc................. Quality Report for SSAD
                             LCP_RLCA_QR_S04b_TXX.doc................... Quality Report for LCP
                             FRD_RLCA_QR_S04b_TXX.doc................... Quality Report for FRD
                             UML_RLCA_QR_S04b_TXX.xls................... Quality Report for UML
                             OCD_RLCA_QR_S04b_TXX.xls................... Quality Report for OCD
                             SSRD_RLCA_QR_S04b_TXX.xls.................. Quality Report for SSRD
                             SSAD_RLCA_QR_S04b_TXX.xls................. Quality Report for SSAD
                             LCP_RLCA_QR_S04b_TXX.xls................... Quality Report for LCP
                             FRD_RLCA_QR_S04b_TXX.xls................... Quality Report for FRD
                              ......
           

                   [Folder in /TeamXXb/RLCA]
                   /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_RLCA_S04b_TXX.est........................... COCOMO™ Data (e.g., EST files)
                              COCOMO_RLCA_S04b_TXX.rpt.......................... COCOMO™ Data (e.g., rpt files)
                               ......
　

                   [Folder in /TeamXXb/RLCA]
                   /Plans/..................... [Iteration00], Construction, Transition and Support Plans (plans for the software life cycle)
                             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 Plans

                              QM_Plans_S04b_TXX.doc................. Quality Management Plan
                              QM_Plans_S04b_TXX.pdf................. Quality Management Plan
                              CM_Plans_S04b_TXX.doc................. Configuration Management Plan (optional)
                              CM_Plans_S04b_TXX.pdf................. Configuration Management Plan (optional)
                              Peer_Review_Plan_S04b_TXX.doc........ Peer Review Plans
                              Peer_Review_Plan_S04b_TXX.pdf........ Peer Review Plans
                              Test_Plans_S04b_TXX.doc................. Test Plans
                              Test_Plans_S04b_TXX.pdf................. Test Plans
                              Security_Plans_S04b_TXX.doc........... Security Plans (optional)
                              Security_Plans_S04b_TXX.pdf........... Security Plans (optional)
                              Safety_Plans_S04b_TXX.doc.............. Safety Plans (optional)
                              Safety_Plans_S04b_TXX.pdf.............. Safety Plans (optional)
                              Transition_Plans_S04b_TXX.doc........ Transition Plan
                              Transition_Plans_S04b_TXX.pdf........ Transition Plan
                              Training_Plans_S04b_TXX.doc........... Training Plan (optional)
                              Training_Plans_S04b_TXX.pdf........... Training Plan (optional)
                              Support_Plans_S04b_TXX.doc........... Support Plan
                              Support_Plans_S04b_TXX.pdf........... Support Plan
                              Iteration_Plans_S04b_TXX.doc........... Iteration Plan
                              Iteration_Plans_S04b_TXX.pdf........... Iteration Plan

                               ......

        [Folder in /TeamXXb]
        /IOCSet/ ...................
                  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 IOCSet

                   [Folder in /TeamXXb/IOCSet]
                   /Iteration01/ ...................
                             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 Iteration01

                              IterationPlan_IR01_S04b_TXX.doc................. Iteration Plan
                              IterationPlan_IR01_S04b_TXX.pdf................. Iteration Plan
                              OCD_As-built01_S04b_TXX.doc .................. As built-OCD with summary of changes
                              OCD_As-built01_S04b_TXX.pdf .................. As built-OCD with summary of changes
                              SSRD_As-built01_S04b_TXX.doc ................ As built-SSRD with summary of changes
                              SSRD_As-built01_S04b_TXX.pdf ................ As built-SSRD with summary of changes
                              SSAD_As-built01_S04b_TXX.doc ................ As built-SSAD with summary of changes
                              SSAD_As-built01_S04b_TXX.pdf ................ As built-SSAD with summary of changes
                              FRD_As-built01_S04b_TXX.doc .................. As built-FRD with summary of changes
                              FRD_As-built01_S04b_TXX.pdf .................. As built-FRD with summary of changes
                              LCP_As-built01_S04b_TXX.doc .................. As built-LCP with Risk Management section and summary of changes
                              LCP_As-built01_S04b_TXX.pdf .................. As built-LCP with Risk Management section and summary of changes
                              UML_Model_As-built01_S04b_TXX.mdl ................. As built Rational Rose UML Model Files
                              UML_Model_As-built01_S04b_TXX.zip .........  Model file set (All the files that is related with Rational Rose UML Model Files)  
                              Assessment_IReport01_S04b_TXX.doc........ Iteration Assessment Report
                              Assessment_IReport01_S04b_TXX.pdf........ Iteration Assessment Report
                             Testing_IReport01_S04b_TXX.doc................ Iteration Test Description and Result Report(s)
                             Testing_IReport01_S04b_TXX.pdf................ Iteration Test Description and Result Report(s)
                             ReleaseDescription_IReport01_S04b_TXX.doc................. Iteration Release Description
                             ReleaseDescription_IReport01_S04b_TXX.pdf................. Iteration Release Description
                             Size_IReport01_S04b_TXX.doc.................... Iteration Size Report
                             Size_IReport01_S04b_TXX.pdf.................... Iteration Size Report
                             Peer_Review_Report_S04b_TXX.doc............... Peer Review Report
                             Peer_Review_Report_S04b_TXX.pdf............... Peer Review Report
                               ......
 

                   [Folder in /TeamXXb/IOCSet]
                   /Iteration02/ ...................
                             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 Iteration02

                               ......
 

                   [Folder in /TeamXXb/IOCSet]
                   /IterationNN/ ...................
                             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 IterationN

                               ......
 

        [Folder in /TeamXXb]
        /ImplementationSet/  ................If the files is the same with the FinalDeliverables, you do not put them here, but add the information into readme.txt, but has the index file points to those files
                  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 ImplementationSet
                  OCD_As-built_Final_S04b_TXX.doc .................. As built-OCD with summary of changes
                  OCD_As-built_Final_S04b_TXX.pdf .................. As built-OCD with summary of changes
                  SSRD_As-built_Final_S04b_TXX.doc ................ As built-SSRD with summary of changes
                  SSRD_As-built_Final_S04b_TXX.pdf ................ As built-SSRD with summary of changes
                  SSAD_As-built_Final_S04b_TXX.doc ................ As built-SSAD with summary of changes
                  SSAD_As-built_Final_S04b_TXX.pdf ................ As built-SSAD with summary of changes
                  FRD_As-built_Final_S04b_TXX.doc .................. As built-FRD with summary of changes
                  FRD_As-built_Final_S04b_TXX.pdf .................. As built-FRD with summary of changes
                  UML_Model_As-built_Final_S04b_TXX.mdl ......As built Rational Rose UML Model Files
                  UML_Model_As-built_Final_S04b_TXX.zip ........ Model file set (All the files that is related with Rational Rose UML Model Files)  
 

        [Folder in /TeamXXb]
        /As-buildSpecSet/  ................If the files is the same with the FinalDeliverables, you do not put them here, but add the information into readme.txt, but has the index file points to those files
                  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 As-buildSpecSet
                  UserManual_S04b_TXX.doc.................... User Manual
                  UserManual__S04b_TXX.pdf................... User Manual
                  Transition_Plan_S04b_TXX.doc.................Transition Plan 
                  Transition_Plan_S04b_TXX.pdf..................Transition Plan 
 

        [Folder in /TeamXXb]
        /TransitionSet/  ................If the files is the same with the FinalDeliverables, you do not put them here, but add the information into readme.txt, but has the index file points to those files 
                  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 TransitionSet
                  UserManual_S04b_TXX.doc.................... User Manual
                  UserManual__S04b_TXX.pdf................... User Manual
                  Transition_Plan_S04b_TXX.doc.................Transition Plan 
                  Transition_Plan_S04b_TXX.pdf..................Transition Plan 
 

                   [Folder in /TeamXXb/TransitionSet]
                   /TRR/ ...................            Presentations with any demo documentation.
                             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 TRR

        [Folder in /TeamXXb]
        /SupportSet/  ................If the files is the same with the FinalDeliverables, you do not put them here, but add the information into readme.txt, but has the index file points to those files  
                  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 SupportSet
                  Regression_S04b_TXX.doc...................... Regression Test Package
                  Regression_S04b_TXX.pdf....................... Regression Test Package
                  Tools_S04b_TXX.doc.............................. Packaged Tools and Procedures
                  Tools_S04b_TXX.pdf............................... Packaged Tools and Procedures 
                  Support_Plan_S04b_TXX.doc...................Support Plan 
                  Support_Plan_S04b_TXX.pdf....................Support Plan 
                  Training_Materials_S04b_TXX.zip..............Training Materials 
 

                   [Folder in /TeamXXb/SupportSet]
                   /RRR/ ...................            Presentations with any demo documentation.
                             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 PRR

        [Folder in /TeamXXb]
        /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 following files 

                  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 
                                                  
                  Source_Final_S04b_TXX.zip.............................. Final Software Source Code
                  Software_Final_S04b_TXX.zip........................... Final Software Distribution (executables, manual...)
                  ReleaseDescription_Final_S04b_TXX.doc.................. Final Release Description
                  ReleaseDescription_Final_S04b_TXX.pdf................... Final Release Description
                  UserManual_Final_S04b_TXX.doc.................... User Manual
                  UserManual_Final_S04b_TXX.pdf..................... User Manual
                  Regression_Final_S04b_TXX.doc...................... Regression Test Package
                  Regression_Final_S04b_TXX.pdf....................... Regression Test Package
                  Tools_Final_S04b_TXX.doc.............................. Packaged Tools and Procedures
                  Tools_Final_S04b_TXX.pdf............................... Packaged Tools and Procedures 
                  Transition_Plan_S04b_TXX.doc..........................Transition Plan 
                  Transition_Plan_S04b_TXX.pdf...........................Transition Plan 
                  Support_Plan_S04b_TXX.doc............................Support Plan 
                  Support_Plan_S04b_TXX.pdf.............................Support Plan 
                  Training_Materials_S04b_TXX.zip.......................Training Materials 
                  Closeout_Report_S04b_TXX.doc........................Closeout Report 
                  Closeout_Report_S04b_TXX.pdf.........................Closeout Report 
                  Size_Report_S04b_TXX.doc............................... Size Report in Data collection Set 
                  Size_Report_S04b_TXX.pdf............................... Size Report in Data collection Set 
                  Problem_Report_S04b_TXX.zip  .........................Problem Report  in Data collection Set 
 

               [Folder in /TeamXXb/FinalDeliverables]
               /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_Final_S04b_TXX.est........................... COCOMO™ Data (e.g., EST files)
                         COCOMO_Final_S04b_TXX.rpt......................... COCOMO™ Data (e.g., rpt files)
                         COQUALMO_Final_SPD-8_S04b_TXX.doc............. COQUALMO Data
                          ......