[Gzz-commits] manuscripts/UMLLink article.rst

[Asko Soukka]

CVSROOT:        /cvsroot/gzz
Module name:    manuscripts
Changes by:     Asko Soukka <address@hidden>    03/02/15 16:50:19

Modified files:
        UMLLink        : article.rst 

Log message:
        twid

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

Patches:
Index: manuscripts/UMLLink/article.rst
diff -u manuscripts/UMLLink/article.rst:1.91 
manuscripts/UMLLink/article.rst:1.92
--- manuscripts/UMLLink/article.rst:1.91        Sat Feb 15 16:47:41 2003
+++ manuscripts/UMLLink/article.rst     Sat Feb 15 16:50:19 2003
@@ -9,7 +9,7 @@
 .. Alternative title: "Free Software toolchain for bidirectional 
    linking between UML diagrams and Javadoc"
 
-.. :Stamp: $Id: article.rst,v 1.91 2003/02/15 21:47:41 tuukkah Exp $
+.. :Stamp: $Id: article.rst,v 1.92 2003/02/15 21:50:19 humppake Exp $
 
 .. Points for HT people
    ====================
@@ -98,7 +98,7 @@
 We present a navigational aid for software engineering documentation.
 Based on using UML diagrams as multi-ended links, we hypertexturally
 connect two
-distinct areas of software engineering documentation: architectural documents 
and javadoc.
+distinct areas of software engineering documentation: design documents and 
javadoc.
 
 and its lightweight implementation
 on top of a Free Software
@@ -123,7 +123,7 @@
 In this article, we present a navigational aid for software documentation.
 Based on using UML diagrams as multi-ended links, our tool connects two
 distinct areas of software engineering documentation: 
-the general architectural documents and the detailed method-level javadoc 
documentation.
+the general design documents and the detailed method-level javadoc 
documentation.
 
 .. XXX This means the software was deployable without further authoring.
 
@@ -383,7 +383,7 @@
 has explicitly written the instructions into the doc comments,
 the Javadoc will only explain how the interface is used.
 What is exasperates this situation is the certainty 
-that in the architectural document, there surely is a diagram and a section
+that in the design document, there surely is a diagram and a section
 which talks about the issue but finding them will take time.
 
 The distinct pieces (Javadoc and the
@@ -396,7 +396,7 @@
 details would be useful, and when looking at a Javadoc, it would be
 most useful to be able to see if any design documents discuss that class
 or package.
-We believe that the architecture document would be read more if 
+We believe that the design documentation would be read more if 
 made easily reachable from relevant parts of Javadoc. 
 
 This is the
@@ -462,26 +462,26 @@
    Linking possibilities from items in different kinds of UML diagrams 
    to Javadoc.
 
-   +---------------------+---------------------+--------------------+
-   | Conceptual          | Specification       | Implementation     |
-   +=====================+=====================+====================+
-   | probably no links   | can link Java       | can link all       |
-   | to javadoc          | interface and       | classes            |
-   |                     | some classes        |                    |
-   +---------------------+---------------------+--------------------+
-   | the design          | can link also Java  | can link all       |
-   | documentation       | packages            | packages           |
-   | packages could be   |                     |                    |
-   | linked withing the  |                     |                    |
-   | architectural       |                     |                    |
-   | documentation       |                     |                    |
-   +---------------------+---------------------+--------------------+
-   | concepts could be   |                     |                    |
-   | linked with the     |                     |                    |
-   | classes that        |                     |                    |
-   | eventially          |                     |                    |
-   | implement it        |                     |                    |
-   +---------------------+---------------------+--------------------+
+   +----------------------+---------------------+--------------------+
+   | Conceptual           | Specification       | Implementation     |
+   +======================+=====================+====================+
+   | probably no links    | can link Java       | can link all       |
+   | to javadoc           | interface and       | classes            |
+   |                      | some classes        |                    |
+   +----------------------+---------------------+--------------------+
+   | the design           | can link Java       | can link all       |
+   | documentation        | interfaces, some    | packages           |
+   | packages could be    | classes and also    |                    |
+   | linked with related  | packages            |                    |
+   | design documentation |                     |                    |
+   | packages             |                     |                    |
+   +----------------------+---------------------+--------------------+
+   | concepts could be    |                     |                    |
+   | linked with the      |                     |                    |
+   | classes that         |                     |                    |
+   | eventially           |                     |                    |
+   | implement it         |                     |                    |
+   +----------------------+---------------------+--------------------+
 
 The UML diagrams enable navigation in various purposes. Applying
 Trigg's taxonomy of different link types [trigg83link-taxonomy]_, we
@@ -915,7 +915,7 @@
 Using 
 existing Free Software tools
 and a little new glue code we have made UML diagrams into
-contextual menus for switching between the architectural design
+contextual menus for switching between the design
 documentation and the detailed Javadoc documentation.
 The current implementation is a part of and in use at our Free
 Software project [gzz]_, where it generates the publicly web-browsable