[Gzz-commits] manuscripts/UMLLink short-paper.rst

[Asko Soukka]

CVSROOT:        /cvsroot/gzz
Module name:    manuscripts
Changes by:     Asko Soukka <address@hidden>    03/04/22 10:57:40

Modified files:
        UMLLink        : short-paper.rst 

Log message:
        whyuml

CVSWeb URLs:
http://savannah.gnu.org/cgi-bin/viewcvs/gzz/manuscripts/UMLLink/short-paper.rst.diff?tr1=1.1&tr2=1.2&r1=text&r2=text

Patches:
Index: manuscripts/UMLLink/short-paper.rst
diff -u manuscripts/UMLLink/short-paper.rst:1.1 
manuscripts/UMLLink/short-paper.rst:1.2
--- manuscripts/UMLLink/short-paper.rst:1.1     Fri Apr 11 09:45:39 2003
+++ manuscripts/UMLLink/short-paper.rst Tue Apr 22 10:57:40 2003
@@ -2,7 +2,7 @@
 Bridging Javadoc and design documentation via UML diagram image maps
 ====================================================================
 
-.. $Id: short-paper.rst,v 1.1 2003/04/11 13:45:39 humppake Exp $
+.. $Id: short-paper.rst,v 1.2 2003/04/22 14:57:40 humppake Exp $
 
 .. short paper == 2 pages, deadline the end of May
 
@@ -32,27 +32,6 @@
    Requirements traceability research
    - [humppake] couldn't find yet
 
-Abstract
-========
-
-.. This could still be good:
-
-We present a navigational aid for documentation used in software
-development. Based on using readily-authored UML diagrams as
-multi-ended links, we hypertexturally connect two distinct areas of
-documentation: design documents and javadoc program code
-documentation.  Connecting the distinct areas is essential because it
-could help new developers in getting productive and supports
-development processes where both design and implementation change
-continuously.
-
-We also describe the lightweight implementation as a supplement to a
-Free Software toolchain.  To achieve bi-directional linking, the
-implementation after-treats HTML pages generated by other tools,
-injecting into referred pages links back to the referring imagemap of
-each UML diagram. Each diagram also servers as a spatial context for
-navigation within target nodes.
-
 - short description about problem:
   * how to make fragmented documentation connected with 
     minimum additional work
@@ -63,6 +42,11 @@
   * generate higher level design documentation
   * connect these levels via UML diagrams drawn design documentation
 
+- why UML
+  * UML as de facto standard for describing software architecture
+  * diagrams already exists, so why not use them
+  * probably not best for navigation, but still better than nothing
+
 - why UML-diagrams would work as menus
   * human made abstraction of the system
   * don't link to everywhere, but to the most essential places
@@ -88,4 +72,4 @@
   * separate navidoc version coming up
 
 - future
-  * fenfire
\ No newline at end of file
+  * fenfire