Partial documentation generation
Overview
The design document template allows the partial generation of the design file. In order to do this, you simply have to select a specific document template document item in the "Partial Generation" tab.
These document items allow you to generate:
·
the
"General design" chapter
· packages and sub-systems
·
nodes
·
classes
·
actors
The "Architecture" document item
This is used to generate the "Architecture" chapter.
The "DescriptionOfTheClasses" document item
This allows you to generate the description of the classes belonging to the current element.
The "DescriptionOfTheComponents" document item
This allows you to generate the description of the components 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 "DescriptionOfTheNodes" document item
This is used to generate the description of the nodes belonging to the current element.
The "DescriptionOfThePackageCompleteHierarchy" document item
This is used to generate description of all the sub-packages.
The "DescriptionOfTheSubsystemCompleteHierarchy" document item
This is used to generate a description of all sub-systems.
The "DescriptionOfThePackageActors" document item
This is used to generate the description of the actors belonging to the current element.
The "PackageUseCase" document item
This is used to generate the package "Use cases" chapter.
The "GeneralDesign" document item
This is used to generate the "General design" chapter.
The "Integration" document item
This is used to generate the "Integration" chapter.
The "Overview" document item
This is used to generate the "Overview" chapter.
The "DescriptionOfThePackageUseCases" document item
This is used to generate the description of the use cases belonging to the current package.
The "Traceability" document item
This is used to generate the "Traceability" chapter.