ArgoPDF

    Report
 

This part describes the structure of the report.

Generated report have next structure:

  1. title page
  2. table of contents
  3. generated data of the corresponded ArgoUML project

Title page includes:

  • Name of the ArgoUML project
  • Logo of the project (if it was selected by the user)
  • Author name

Table of contents includes:

  • Names of chapters of the generated report

Generated data of the corresponded ArgoUML project includes:

This part of the report is under construction. Before defining which data can be included, it is important to analyze and choose main components, subcomponents of the ArgoUML projects and so on. My simple preliminary analysis (Dzmitry Churbanau, June 2007) shows, that main part of the report should include next components (the order of this components can be changed, some components can be removed and new components can be added):

  1. Use Case diagrams
  2. Class diagrams
  3. Sequence diagrams
  4. Collaboration diagrams
  5. Statechart diagrams
  6. Activity diagrams
  7. Deployment diagrams
  8. Packages

Of course, all this components can include subcomponents.

The suggestion of Linus Tolke about report structure is next:

  1. All Use Cases
  2. Packages hierarchically with, for each package
    1. Class diagrams with, for each class in the diagram
      1. Attributes and operations
      2. Statechart diagrams
    2. Object diagrams
    3. Sequence and Collaborations diagrams in the order they appear
    4. Activity diagrams
  3. All Deployment diagrams