[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:19:36

Modified files:
        UMLLink        : umllink.rst 

Log message:
        clarify steps

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

Patches:
Index: manuscripts/UMLLink/umllink.rst
diff -u manuscripts/UMLLink/umllink.rst:1.25 
manuscripts/UMLLink/umllink.rst:1.26
--- manuscripts/UMLLink/umllink.rst:1.25        Tue Jan 21 08:17:13 2003
+++ manuscripts/UMLLink/umllink.rst     Tue Jan 21 08:19:36 2003
@@ -2,7 +2,7 @@
 A free software toolchain for bidirectional linking between UML diagrams and 
Javadoc
 
====================================================================================
 
-:Last-Modified: $Date: 2003/01/21 13:17:13 $
+:Last-Modified: $Date: 2003/01/21 13:19:36 $
 
 Introduction
 ============
@@ -171,33 +171,42 @@
    + 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
+
+Advantage over paper: MARGINAL: automatize cross-indexing
 
 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
+Advantage over paper: SOME: see the contexts of a class,
+traverse them
 
 Step 3; backlinks to the architecture documentation
 """""""""""""""""""""""""""""""""""""""""""""""""""
+   + "focus+context menu"-metaphor for diagrams 
+
+       + we highlight the "focused" element 
+         of the diagram
+   
+       + we can
+         "step back" from class documentation back to 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%.
+
+Advantage over paper: MAJOR: multi-end links easily traversable,
+structure can be understood
+
 
 Documentation's developer's point of view
 -----------------------------------------