[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Gzz-commits] manuscripts UMLLink/article.rst ./gzigzag.bib
From: |
Tuukka Hastrup |
Subject: |
[Gzz-commits] manuscripts UMLLink/article.rst ./gzigzag.bib |
Date: |
Sat, 15 Feb 2003 15:57:53 -0500 |
CVSROOT: /cvsroot/gzz
Module name: manuscripts
Changes by: Tuukka Hastrup <address@hidden> 03/02/15 15:57:53
Modified files:
UMLLink : article.rst
. : gzigzag.bib
Log message:
adjusted headings, fixed refs
CVSWeb URLs:
http://savannah.gnu.org/cgi-bin/viewcvs/gzz/manuscripts/UMLLink/article.rst.diff?tr1=1.85&tr2=1.86&r1=text&r2=text
http://savannah.gnu.org/cgi-bin/viewcvs/gzz/manuscripts/gzigzag.bib.diff?tr1=1.48&tr2=1.49&r1=text&r2=text
Patches:
Index: manuscripts/UMLLink/article.rst
diff -u manuscripts/UMLLink/article.rst:1.85
manuscripts/UMLLink/article.rst:1.86
--- manuscripts/UMLLink/article.rst:1.85 Sat Feb 15 15:57:25 2003
+++ manuscripts/UMLLink/article.rst Sat Feb 15 15:57:53 2003
@@ -9,7 +9,7 @@
.. Alternative title: "Free Software toolchain for bidirectional
linking between UML diagrams and Javadoc"
-.. :Stamp: $Id: article.rst,v 1.85 2003/02/15 20:57:25 humppake Exp $
+.. :Stamp: $Id: article.rst,v 1.86 2003/02/15 20:57:53 tuukkah Exp $
.. Points for HT people
====================
@@ -129,8 +129,8 @@
its implementation. Finally, we discuss our practical use of the tool
and conclude.
-Background: Documentation in Software Engineering
-=================================================
+Background
+==========
Software engineering process
----------------------------
@@ -266,7 +266,7 @@
intercommunication within our group, we believe manually made human
abstracted documentation serves our purposes best.
-UML Diagrams
+UML diagrams
------------
The Unified Modeling Language (UML) is the standard way to
@@ -311,8 +311,8 @@
.. some references to the screenshots here?
-The problem of two separate bodies of documentation
-===================================================
+Setting of problem
+==================
In our software engineering project [gzz]_, as probably in most projects that
use the Java programming
language [java-ref]_, the software development documentation is
@@ -399,8 +399,8 @@
links.
-A design for multi-directional navigation through UML diagram imagemaps
-=======================================================================
+Structure design
+================
Usability considerations
------------------------
@@ -444,9 +444,9 @@
To see which possibilities we have when linking from diagrams, we use
Cook and Daniels's classification of UML diagrams into three classes
-[cook-daniels-94-oo-modelling]_: conceptual diagrams, specification
+[cook-daniels94-oo-modelling]_: conceptual diagrams, specification
diagrams and implementation diagrams. Looking into the items available in
-each of these classes, we come to the conclusion shown in Table [linking-ref]_.
+each of these classes, we come to the conclusion shown in Table [ref-linking]_.
.. figure:: table
:environment: table
@@ -496,7 +496,7 @@
Semantic meanings of traversing the bi-directional links of a diagram.
Curves mean linkage by spatial relation.
-Documentation reader's point of view
+Reader's point of view
---------------------------------------
.. at least here we should also refer to the screenshots
@@ -555,7 +555,7 @@
.. Advantage over paper: MAJOR: multi-end links easily traversable,
structure can be understood
-Documentation developer's point of view
+Authors's point of view
-----------------------------------------
On the developer side, creating diagrams within the design
@@ -682,6 +682,7 @@
a description of all the elements in diagram [ref-umltoolumlsourcelinked]_
and description their graphical layout [ref-umltoolmpsource]_. The
final diagram [ref-umltoolexample]_ is compiled
+
[ref-umltoolconvert]_ from the element and layout descriptions. The
description of existing elements is easily done using our UML tools'
lexical description language and the description is readable even
@@ -853,8 +854,8 @@
The two distinct phases of generating Javadoc and design
documentation bridged via UML diagrams.
-Practical use
-=============
+Experiences
+===========
The UML and linking tools are currently in everyday use in the Gzz
project [gzz]_. For now, the documentation covers about 380 Java classes
@@ -960,7 +961,7 @@
===============
The authors would like to thank Toni Alatalo for discussions regarding
-this manuscript and Benja Fallenstein for discussions, proofreading,
+this manuscript and Benja Fallenstein for discussions and proofreading,
and participation in implementing the software.
.. bibliography:: gzigzag
Index: manuscripts/gzigzag.bib
diff -u manuscripts/gzigzag.bib:1.48 manuscripts/gzigzag.bib:1.49
--- manuscripts/gzigzag.bib:1.48 Sat Feb 15 15:43:41 2003
+++ manuscripts/gzigzag.bib Sat Feb 15 15:57:53 2003
@@ -1397,7 +1397,7 @@
pages = "17--41",
}
address@hidden,
address@hidden,
author = {Friendly, Lisa},
title = {The Design of Distributed Hyperlinked Programming
Documentation},
year = {1995},
@@ -1726,6 +1726,7 @@
}
@Misc{fsf02categories,
+ key = {Free Software Foundation, Inc},
publisher = {Free Software Foundation, Inc},
title = {{Categories of Free and Non-Free Software}},
year = {2002},
@@ -1733,6 +1734,7 @@
}
@Misc{fsf02classpath,
+ key = {Free Software Foundation, Inc},
publisher = {Free Software Foundation, Inc},
title = {{GNU Classpath-tools}},
year = {2002},
@@ -1754,6 +1756,7 @@
}
@Misc{tigris03argouml,
+ key = {Tigris.org},
publisher = {Tigris.org - Open Source Software Engineering},
title = {{ArgoUML} - A modelling tool for design using {UML}},
howpublished = {\url{http://argouml.tigris.org/} Tigris.org - Open Source
Software Engineering},
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- [Gzz-commits] manuscripts UMLLink/article.rst ./gzigzag.bib,
Tuukka Hastrup <=