Changes between Initial Version and Version 1 of Paose/Documentation/HowTo-CDDs

Timestamp:

Sep 6, 2010, 10:30:29 PM (14 years ago)

Author:

Lawrence Cabac

Comment:

Added Howto CDDs

Paose/Documentation/HowTo-CDDs

@@ +1 @@
+= Howto CDDs =
+
+== (1) Description ==
+
+CDDs (Coarse Design Diagrams) define the coarse structure of a Mulan MAA (multi-agent application). In the fashion and adopting the syntax of Use Case Diagrams the tool allows to depict agent roles as actors and interactions as cases. Thus the tool defines the coarse matrix of roles and interaction for an MAA, i.e. structure and behavior. In addition to the generation of a folder structure for the specified MAA the tool also offers the export of the matrix to a table (latex) and to produce a html image map output for the diagram.
+
+''Note that the tool is in a highly prototypical state, it is called UseCaseComponents, as the name was chosen in early stages of development and the drawing elements are designed using the concept of Net Components.''
+
+== (2) Embedment in the PAOSE Development Process ==
+[[ImageSvg(Paose-detailed-CDD.svg)]]
+
+== (3) Usage ==
+
+Start Renew and activate the palette for the diagram tools (Tools >> Net Components >> Use Case Components). The tools functions with net drawings: File >> New Net Drawing (Ctrl-N). With the drawing tools from the palette actors, interactions (cases) and arcs (no arrow tip) can be drawn. These drawing elements (actually Net Components) already provide a standard inscription, which can be adapted easily (right-click to edit).
+
+The tool allows to generate the folder structure for a Mulan MAA (multi-agent application) in the form of a standard Renew plugin. 
+
+== Generator ==
+The Generator of the !UseCase plugin generates skeletons for the system. 
+It facilitates Velocity templates for that cause. 
+Following parts are generated: 
+ - Folder structure of the plugin with source code structur for
+  - Interactions (. . . /interactions/) 
+  - Roles (. . . /roles/) 
+  - Ontology (. . . /ontology/) 
+  - Knowledge bases (KB) and Roles/Dependencies Diagram (. . . /agents/) 
+ - Ant build-Script (build.xml) 
+ - Plugin configuration (plugin.cfg) 
+ - Start scripts (start.sh, sartCapa.rnw, startKBE.sh) 
+ - Skeleton:  Roles/Dependencies Diagram and a Project-File (!RolesDependencies.mad, pro jects.xml) 
+ - Protégé: Ontology Files (<name>.pprj, <name>.pons, <name>.pint) 
+ - Skeletons: AIPs for all Interactions, containing role names of all Participants. (<interaction>.aip) 
+After generation the plugin compiles with ant, it can be deployed through a repository (subversion) and the domain specific design of the system starts.
+
+
+== (4) Inscriptions (Actors, Interactions): ==
+(to be done)