search

dddvision / functionalnavigation

Trajectory Optimization Manager for Multiple Algorithms and Sensors (TOMMAS)
3 stars 4 forks source link

Need for better documentation #25

Open GoogleCodeExporter opened 9 years ago

GoogleCodeExporter commented 9 years ago 
This project should provide UML digrams
 * Layering or stack diagrams
 * Use case diagrams
 * Activity diagrams
 * Class diagrams

This can be done using rational enterprise architect, rose, argouml, visios, 
bouml, poseidonx, etc.

Also, a TOMMAS application creates DynamicModels and Measures, but the current 
class diagram shows that the Optimizer creates them.

Original issue reported on code.google.com by dddvis...@gmail.com on 30 Aug 2010 at 3:58

GoogleCodeExporter commented 9 years ago

Original comment by dddvis...@gmail.com on 30 Aug 2010 at 4:03

GoogleCodeExporter commented 9 years ago 
UML diagram notes:

 * Class diagrams
   * Produced by dOxygen
   * Explicitly show the AbstractFactory pattern (see attached)

 * Use case diagram and text
   * Install TOMMAS (user, system integrator, developer)
   * Install Component (user, system integrator, developer)
   * Configure System (user, system integrator, developer)
   * Run TOMMAS Demo (user, system integrator, developer)
   * Run Component Test (system integrator, developer)
   * Create DynamicModel (developer)
   * Create Measure (developer)
   * Create Optimizer (developer)

 * Layering or stack diagram showing system requirements (see attached)

Original comment by dddvis...@gmail.com on 2 Sep 2010 at 12:21

Attachments:

GoogleCodeExporter commented 9 years ago 
 * Sequence diagrams showing the big picture of what happens
   * demo - initialization, connect, Measure.Factory, DynamicModel.factory, Optimizer.factory, step, getResults, display, loop
   * testbed - initialization, connect, isConnected, test all functions

Original comment by dddvis...@gmail.com on 2 Sep 2010 at 12:31

GoogleCodeExporter commented 9 years ago 
Add dOxygen tags @see, @link, and @file in appropriate places.

Original comment by dddvis...@gmail.com on 2 Sep 2010 at 2:19

GoogleCodeExporter commented 9 years ago 
Each file should contain a reference to the functionalnavigation project on 
Google Code and LICENSE.txt. Then README.txt can be deleted. Also, be sure to 
run unix2dos on all files.

The class diagram has been updated.

Original comment by dddvis...@gmail.com on 8 Sep 2010 at 2:23

GoogleCodeExporter commented 9 years ago 
Introduction on the wiki main page could use to have a little more description 
of the motivations behind the project: why is it necessary, how it addresses 
concerns that have not been met by other approaches.

Original comment by bob.lo...@gmail.com on 24 Sep 2010 at 6:04

GoogleCodeExporter commented 9 years ago 
The use cases related to the Optimizer need to specify:
 * Is there a performance objective to meet? (in terms of a real valued tolerance between the minimum cost output and the theoretical minimum).
 * Is there a limit to the computational effort in terms of processor or wall clock time?

Original comment by dddvis...@gmail.com on 13 Dec 2010 at 10:20