[Gzz-commits] manuscripts/UMLLink umllink.rst

[Tuomas J. Lukka]

CVSROOT:        /cvsroot/gzz
Module name:    manuscripts
Changes by:     Tuomas J. Lukka <address@hidden>        03/01/21 08:17:13

Modified files:
        UMLLink        : umllink.rst 

Log message:
        separate steps

CVSWeb URLs:
http://savannah.gnu.org/cgi-bin/viewcvs/gzz/manuscripts/UMLLink/umllink.rst.diff?tr1=1.24&tr2=1.25&r1=text&r2=text

Patches:
Index: manuscripts/UMLLink/umllink.rst
diff -u manuscripts/UMLLink/umllink.rst:1.24 
manuscripts/UMLLink/umllink.rst:1.25
--- manuscripts/UMLLink/umllink.rst:1.24        Tue Jan 21 08:10:11 2003
+++ manuscripts/UMLLink/umllink.rst     Tue Jan 21 08:17:13 2003
@@ -2,7 +2,7 @@
 A free software toolchain for bidirectional linking between UML diagrams and 
Javadoc
 
====================================================================================
 
-:Last-Modified: $Date: 2003/01/21 13:10:11 $
+:Last-Modified: $Date: 2003/01/21 13:17:13 $
 
 Introduction
 ============
@@ -153,34 +153,51 @@
     - can be useful to link even concept with the class that eventually 
implemented
       it.
 
-
+ - First stage: link only classifiers, and only where the author of the UML
+   diagram explicitly specified a link. In interaction diagrams, it's also easy
+   to find the relevant method from the javadoc.
 
 Documentation's reader's point of view
 ---------------------------------------
 
-Our developing steps:
+When developing
+
+Step 0; distinct architecture documentation with UML diagrams and javadoc 
generated from the sourcecode.
+""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
 
+Advantage over paper: NONE
 
- - step 0; distinct architecture documentation with UML diagrams 
-   and javadoc generated from the sourcecode.
-   Advantage over paper: NONE
- - step 1; links from architecture documentation's UML-diagrams into
-   relevant javadoc class documentations
+Step 1; links from architecture documentation's UML-diagrams into relevant 
javadoc class documentations
+"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
    + when only following dummy link into some part of 
      javadoc tree, we would lost the class' context in the architecture
      documentation we started
    Advantage over paper: MARGINAL: automatize cross-indexing
- - step 2; embedding UML-diagrams into javadoc, linking also them
+
+Step 2; embedding UML-diagrams into javadoc, linking also them
+""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
+
    + though, this is not yet enough, because we want to know
       where classes are referred in architecture documentation
    + "focus+context menu"-metaphor for diagrams needs that we can
      "step back" from class documentation back to architecture
      documentation
+
+   + infuriating to the user that the diagram allows navigation
+     between *almost* all contexts it is shown in.
+
+   + diagrams a little cluttery 
+
    Advantage over paper: SOME: see the contexts of a class,
    traverse them
- - step 3; backlinks to the architecture documentation
-   + all this (UML and rerer backlinks)  drawn into diagram for consistency
-   Advantage over paper: MAJOR: multi-end links easily traversable,
-   structure can be understood
+
+Step 3; backlinks to the architecture documentation
+"""""""""""""""""""""""""""""""""""""""""""""""""""
+    + all this (UML and rerer backlinks)  drawn into diagram for consistency
+      Advantage over paper: MAJOR: multi-end links easily traversable,
+      structure can be understood
+
+    + because we can now go to the architectural document from the javadoc,
+      we can reduce the size of the diagram in the javadoc by 50%.
 
 Documentation's developer's point of view
 -----------------------------------------