Partial documentation generation

Overview

The analysis document template allows the partial generation of the analysis document. To carry out this partial generation, go into the "Partial generation" tab and select a particular document item from the document template.

These document items are used to generate:

· the "Overview" chapter

· the "Preliminary specification" chapter

· the "Definition of the use cases" chapter

· the "Detailed specification" chapter

· user packages

· non-user packages

· the "Use cases" chapter

· classes

· interfaces

· the class or interface "Use cases" chapter

· actors

· use cases

The "Overview" document item

This is used to generate the "Overview" chapter.

The "Preliminary Specification" document item

This is used to generate the "Preliminary Specification" chapter.

The "DefinitionOfTheUseCases" document item

This is used to generate the "Definition of the use cases" chapter.

The "DetailedSpecification" document item

This is used to generate the "Detailed specification" chapter.

The "DescriptionOfTheUserPackages" document item

This is used to generate the description of all the sub-packages annotated {usecase}.

The "DescriptionOfTheNonUserPackages" document item

This is used to generate the description of all the sub-packages not annotated {usecase}.

The "PackageUseCases" document item

This is used to generate the "Use cases" chapter for packages.

The "DescriptionOfThePackageActors" document item

This is used to generate the description of the actors belonging to the current package.

The "DescriptionOfTheClasses" document item

This is used to generate the description of the classes belonging to the current element.

The "DescriptionOfTheInterfaces" document item

This is used to generate the description of the interfaces belonging to the current element.

The "DescriptionOfThePackageUseCases" document item

This is used to generate the description of the use cases belonging to the current package.

The "DescriptionOfTheReferencedNonUserPackages" document item

This is used to generate the description of the packages not annotated {usecase}, linked by an ElementImport.

The "DescriptionOfTheReferencedUserPackages" document item

This is used to generate the description of the packages annotated {usecase}, linked by an ElementImport.