[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:10:11

Modified files:
        UMLLink        : umllink.rst 

Log message:
        reorg

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

Patches:
Index: manuscripts/UMLLink/umllink.rst
diff -u manuscripts/UMLLink/umllink.rst:1.23 
manuscripts/UMLLink/umllink.rst:1.24
--- manuscripts/UMLLink/umllink.rst:1.23        Tue Jan 21 08:06:12 2003
+++ manuscripts/UMLLink/umllink.rst     Tue Jan 21 08:10:11 2003
@@ -2,7 +2,7 @@
 A free software toolchain for bidirectional linking between UML diagrams and 
Javadoc
 
====================================================================================
 
-:Last-Modified: $Date: 2003/01/21 13:06:12 $
+:Last-Modified: $Date: 2003/01/21 13:10:11 $
 
 Introduction
 ============
@@ -18,6 +18,9 @@
     view of the elements that make up a system."
 
 
+Recently, various approaches have been developed towards
+unifying software architecture documents and code (REFS)
+
 In this article, we present the tools we developed
 for using UML diagrams as multiple-ended hyperlinks
 between the architectural documents and javadoc.
@@ -32,6 +35,11 @@
 
 ... something that mentions the architectural documents
 
+- creating UML diagrams to natural part of our design (pegboard) and
+  documenting (architecture docs) process
+  + how our development process diffs from "the common way"?
+  + too small budget for large tookillls like Rational Rose
+
 UML
 ---
 
@@ -94,6 +102,11 @@
 
 Architectural docs with UML diagrams: 
 
+    - diagrams are from human to human
+         + we don't wan to generate diagrams from the code or generate
+           code from the diagrams
+         + generated diagrams are too detailed to be beneficial
+
     - good overall picture. 
 
     - little detail, 
@@ -107,21 +120,13 @@
     - distinct from the javadoc, hard to find explanations
       for a particular class.
 
+    - these cover the most relevant parts from the architecture and the code
+
 The two types of documentation are complementary.
 
 "Obvious" question: can we increase the overall value by
 interconnecting the two?
 
-- distinct architecture documentation, where diagrams are from human to human
-  + we don't wan to generate diagrams from the code or generate
-    code from the diagrams
-  + generated diagrams are too detailed to be beneficial
-  + these cover the most relevant parts from the architecture and the code
-- creating UML diagrams to natural part of our design (pegboard) and
-  documenting (architecture docs) process
-  + how our development process diffs from "the common way"?
-  + too small budget for large tookillls like Rational Rose
-
 
 Design
 ======
@@ -287,12 +292,12 @@
 
     - using existing free software tools
 
+    - plugins for documentation tool (javadoc replacement)
+      outputs: easily adaptable to others.
 
 -free software chain
--flow diagram
 
-- plugins for documentation tool outputs: easily adaptable
-  to others.
+-flow diagram
 
 Practical use
 =============
@@ -326,3 +331,6 @@
 
 - Currently, we only link UML classifiers to Java classes. Methods could
   also be linked, especially in interaction diagrams.
+
+
+