[Gzz-commits] manuscripts/UMLLink SCRATCH umllink.rst

[Asko Soukka]

CVSROOT:        /cvsroot/gzz
Module name:    manuscripts
Changes by:     Asko Soukka <address@hidden>    03/01/27 05:38:18

Modified files:
        UMLLink        : SCRATCH umllink.rst 

Log message:
        solving issues...

CVSWeb URLs:
http://savannah.gnu.org/cgi-bin/viewcvs/gzz/manuscripts/UMLLink/SCRATCH.diff?tr1=1.9&tr2=1.10&r1=text&r2=text
http://savannah.gnu.org/cgi-bin/viewcvs/gzz/manuscripts/UMLLink/umllink.rst.diff?tr1=1.47&tr2=1.48&r1=text&r2=text

Patches:
Index: manuscripts/UMLLink/SCRATCH
diff -u manuscripts/UMLLink/SCRATCH:1.9 manuscripts/UMLLink/SCRATCH:1.10
--- manuscripts/UMLLink/SCRATCH:1.9     Fri Jan 24 04:20:26 2003
+++ manuscripts/UMLLink/SCRATCH Mon Jan 27 05:38:17 2003
@@ -1,4 +1,4 @@
-:Stamp: $Id: SCRATCH,v 1.9 2003/01/24 09:20:26 humppake Exp $
+:Stamp: $Id: SCRATCH,v 1.10 2003/01/27 10:38:17 humppake Exp $
 
    + and if design documentation is outdated some particular classes
      maybe don't even exist anymore!
@@ -33,6 +33,9 @@
 
 - Mapping UML to JAVA (generating Java code from UML);
   http://doi.acm.org/10.1145/353171.353184
+
+- Automatically connecting documentation to code with rose;
+  http://doi.acm.org/10.1145/584955.584979 
   
 why uml
 -------
Index: manuscripts/UMLLink/umllink.rst
diff -u manuscripts/UMLLink/umllink.rst:1.47 
manuscripts/UMLLink/umllink.rst:1.48
--- manuscripts/UMLLink/umllink.rst:1.47        Sun Jan 26 08:56:15 2003
+++ manuscripts/UMLLink/umllink.rst     Mon Jan 27 05:38:17 2003
@@ -2,7 +2,7 @@
 A free software toolchain for bidirectional linking between UML diagrams and 
Javadoc
 
====================================================================================
 
-:Stamp: $Id: umllink.rst,v 1.47 2003/01/26 13:56:15 tjl Exp $
+:Stamp: $Id: umllink.rst,v 1.48 2003/01/27 10:38:17 humppake Exp $
 
 Issues
 ======
@@ -47,8 +47,21 @@
   is better than too detailed, automaticly up-to dated 
   and reverse engineered diagram.
 
+    SUGGESTED RESOLUTION: We use UML in our architectural 
+    documentation to support our group's intercommunication and
+    describing our project to the open software community. In
+    this use the readability and intelligibility (well abstracted
+    and neatly adjustedt) matters over detailed up-to-dated
+    class spesifications.
+    
 - how rational rose links diagrams into code and documentation?
 
+    STILL UNRESOLVED :( Probably all documentation is stored in
+    its datamodel and when generating sourcecode, the documentation
+    is embedded into source as comments. Documentation in the datamodel
+    could at least be browsed through hierarchical tree view, don't know
+    yet about cross-hierarchical links...
+
 Introduction
 ============
 
@@ -121,6 +134,10 @@
       in the technology, the goasl of the effort, the overall strategy, and
       the plan of work." "Intercommunication is worse."
 
+    - our group's working culture - flexible work times and and
+      decentralized working places - is especially vulnerable to 
+      intercommunication problems
+
 UML
 ---
 
@@ -243,12 +260,6 @@
  - fully generated documentation from javadoc comments
    of each class and method in the java source code
 
-
-
-
-
-
-
 The two types of documentation are complementary, as demonstrated in the 
following table:
 
 
+----------------------------------------+----------------------------------------------+
@@ -549,10 +560,6 @@
 
      - placement: currently metapost; looking at ways to make 
        interactively editable.
-
-
-
-
 
 Practical use
 =============