Guidelines

Storing Project Deliverables

• Store project deliverables in the following directory structure (for a hypothetical team, TeamX):
• Please make sure to use exactly the same names, since as you know, UNIX is case-sensitive!

 

 

Directory Structure for TeamX
/TeamX/
      README
      index.html
      /LCO/ .................. Life-Cycle Objective
          README
          /OCD/ .............. Operational Concept Description
          /SSRD/ ............. System and Software Requirements Definition
          /SSAD/ ............. System and Software Architecture Description
          /FRD/ .............. Feasibility Rationale Document
          /LCP/ .............. Life Cycle Plan
          /MDL/ .............. Models (e.g., Rational Rose Model Files)
          /PROTO/ ............ Prototypes
          /ARB/ .............. Architecture Review Board Presentation
          /WINWIN/ ........... WINWIN Data
                 /Customer/... The customer's Windb file
                 /User/....... The user's windb file
                 /Prototypist/ The prototypist's windb file
                 /Architect/.. The architect's windb file
                 /Manager/.... The project manager's windb file
          /COCOMO/............ COCOMO Data (e.g., EST, RPT files)
      /LCA/ .................. Life-Cycle Architecture
          README
          /OCD/ .............. Operational Concept Description
          /SSRD/ ............. System and Software Requirements Definition
          /SSAD/ ............. System and Software Architecture Description
          /FRD/ .............. Feasibility Rationale Document
          /LCP/ .............. Life Cycle Plan
          /MDL/ .............. Models (e.g., Rational Rose Model Files)
          /PROTO/ ............ Prototypes
          /ARB/ .............. Architecture Review Board Presentation
          /WINWIN/ ........... WINWIN Data
                 /Customer/... The customer's Windb file
                 /User/....... The user's windb file
                 /Prototypist/ The prototypist's windb file
                 /Architect/.. The architect's windb file
                 /Manager/.... The project manager's windb file
          /COCOMO/............ COCOMO Data (e.g., EST, RPT files)
 

• Use ONLY relative links; this will allow the Center for Software Engineering to move the projects to the archive without breaking any links. In particular, if your prototype is web-based, it should still work. If your prototype absolutely requires absolute references, document those in a README file.
• If you create a README file (no extension), in a directory that does not have an index.html file, some HTTP servers display the contents of the directory, and append to that the contents of the README file, which is a very easy simple way to display the directory structure, and its contents
• If you generate subdirectories other than the ones listed below, generate a README file explaining the contents of those various directories
• Keep the number of files lying around in the main team directory at a minimum
• Store HTML document(s), Microsoft Word document(s), graphics, etc...pertaining to the Operational Concept Description (OCD) under ./OCD/. You may add subdirectories (e.g., for images), but OCD.html should in the parent directory. Of course, the same applies for the remaining artifacts
• If you have more than one prototype, store them under /PROTO/ as subdirectories /PROTO1/, /PROTO2/, etc..
• Teams should NOT delete any of the generated artifacts. In particular, the final package should have both, the Life Cycle Objective, and the Life Cycle Architecture version of each of the artifacts. Teams who overwrite the Life Cycle Objective version with the Life Cycle Architecture version will be penalized

General Guidelines

• Rose Model File should be kept in synch with documentation
• Documentation of the prototype (screen shots) should be kept in synch with the live prototype
• Hyperlinking the various documents enforces traceability and consistency checking
• E.g., documentation should hyperlink with WinWin HTML report (win conditions, agreements, taxonomy) 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
• Documentation should contain prototype screen shots. No need to maintain separate Prototyping results document

The Initial Prototype is documented in a separate document. However, further prototyping activities shall be documented in the LCO Package in the OCD and SSRD documents as operational scenarios and user interface requirements--i.e., you will no longer have to maintain a separate document for the prototype.
• Note that the Winwin data includes
• the database file (windb) for each of the stakeholders in the Winwin negotiation
• the HTML report generated by the USC-WinWin

Team Project Homepage

• 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, etc...
• Teams can enhance further their website if desired

The team website should provide links to each of the artifacts, in their Life Cycle Objective version, and the Life Cycle Architecture version.

Note that in this case, the WinWin negotiation link need only point to the HTML report generated by the USC-WinWin tool