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

[Asko Soukka]

CVSROOT:        /cvsroot/gzz
Module name:    manuscripts
Changes by:     Asko Soukka <address@hidden>    03/01/22 10:32:41

Modified files:
        UMLLink        : SCRATCH umllink.rst 

Log message:
        edit

CVSWeb URLs:
http://savannah.gnu.org/cgi-bin/viewcvs/gzz/manuscripts/UMLLink/SCRATCH.diff?tr1=1.5&tr2=1.6&r1=text&r2=text
http://savannah.gnu.org/cgi-bin/viewcvs/gzz/manuscripts/UMLLink/umllink.rst.diff?tr1=1.30&tr2=1.31&r1=text&r2=text

Patches:
Index: manuscripts/UMLLink/SCRATCH
diff -u manuscripts/UMLLink/SCRATCH:1.5 manuscripts/UMLLink/SCRATCH:1.6
--- manuscripts/UMLLink/SCRATCH:1.5     Wed Jan 22 04:13:18 2003
+++ manuscripts/UMLLink/SCRATCH Wed Jan 22 10:32:41 2003
@@ -1,21 +1,61 @@
+:Stamp: $Id: SCRATCH,v 1.6 2003/01/22 15:32:41 humppake Exp $
+:Last-Modified: $Date: 2003/01/22 15:32:41 $
 
-This page lists a lot of UML tools:
-http://plg.uwaterloo.ca/~migod/uml.html
+sources for references
+----------------------
 
 Recommended sources for references: IEEE, ACM
 
-- Labeled, typed links as cues when reading hypertext documents; 
http://search.epnet.com/direct.asp?an=9702214682&db=afh
+- This page lists a lot of UML tools;
+  http://plg.uwaterloo.ca/~migod/uml.html
 
-- Mapping UML to JAVA; http://doi.acm.org/10.1145/353171.353184
-  generating Java code from UML
+- Other non-commercial documentation tools;
+  http://www.stack.nl/~dimitri/doxygen/links.html
 
+- Labeled, typed links as cues when reading hypertext documents;
+  http://search.epnet.com/direct.asp?an=9702214682&db=afh
 
+- Mapping UML to JAVA (generating Java code from UML);
+  http://doi.acm.org/10.1145/353171.353184
+  
+why uml
+-------
 
-Some statements from the UML book (Booch, Jacobson, Rumbaugh, p.6)
-"A model is a simplification of reality."
-"We build models so that we can better understand the system
-we are developing."
+Some statements from the UML book (Booch, Jacobson, Rumbaugh, p.6)::
 
+  "A model is a simplification of reality."
+
+  "We build models so that we can better understand the system
+  we are developing."
+
+a spiral model of software development
+--------------------------------------
+
+Phases:
+
+ * ...
+ * determining objectives, alternatives, constraints
+ * evaluatin alternatives, identifying and resolving risks
+ * developing, verifying
+ * planning next phase
+ * ...
+
+::
+
+  "It fosters the development of spesifications that are not necessarily
+  uniform, exhaustive, or formal, in that they defer detailed elaboration of
+  low-risk software elements and avoid unnecessary breakage in their
+  design until the high-risk elements of the design are stabilized."
+
+  "Overall, risk-driven documents, particularly spesifications and plans, are
+  importatn features of the spiral model. Grean amount of detail are not
+  necessary unless the absence of such detail jeopardizes the project."[#]_
+
+.. [#] Boehm, B. (1988). "A spiral model for software development and 
+       enhancement". IEEE Computer 21 (5), pp. 61-72.
+
+duplication of data issue
+-------------------------
 
 Is the duplication of data an issue here? Even when the idea is that the
 UMLs are hand crafted, and not generated from the code at all, it might be a
@@ -23,6 +63,7 @@
 A solution might be to be able to refer from .uml to the objects somehow.
 Obviously gzz connections would solve this and perhaps this is all clear to
 you, sorry to disturb if so, and clarifications are welcome. --antont
-(updata: re-read the article and saw the "this is a temporary system" note
+
+(update: re-read the article and saw the "this is a temporary system" note
 which refers to this, I guess? we did also discuss this on irc ones so i
 guess the issue is clear -- no need to reply and this can be removed at will)
Index: manuscripts/UMLLink/umllink.rst
diff -u manuscripts/UMLLink/umllink.rst:1.30 
manuscripts/UMLLink/umllink.rst:1.31
--- manuscripts/UMLLink/umllink.rst:1.30        Wed Jan 22 05:37:04 2003
+++ manuscripts/UMLLink/umllink.rst     Wed Jan 22 10:32:41 2003
@@ -2,7 +2,8 @@
 A free software toolchain for bidirectional linking between UML diagrams and 
Javadoc
 
====================================================================================
 
-:Last-Modified: $Date: 2003/01/22 10:37:04 $
+:Stamp: $Id: umllink.rst,v 1.31 2003/01/22 15:32:41 humppake Exp $
+:Last-Modified: $Date: 2003/01/22 15:32:41 $
 
 Introduction
 ============
@@ -21,7 +22,8 @@
 unifying software architecture documents and code (REFS)
 
  * and why they seem to end up generating either the documentation
-   from the code or the code from the documentation
+   from the code or the code from the documentation (antont's note about
+   duplication of data problem)
  * do we need critics against graphical coding with UML somewhere?
    This could be found at least in articles supporting 
    domain spesific languages (which may be used for graphical coding)
@@ -37,57 +39,40 @@
 Software development processes
 ------------------------------
 
-XXX!!!
-
-... something that mentions the architectural documents
-
-- our development process seems to be closing Boehm's spiral model
+- our development process seems to be closing Boehm's spiral model [#]_
   of software development, though our spiral is endless and we
   have probably several of them running simultaneously :)
 
-   * ...
-   * determining objectives, alternatives, constraints
-   * evaluatin alternatives, identifying and resolving risks
-   * developing, verifying
-   * planning next phase
-   * ...
-
-  "It fosters the development of spesificatinos that are not necessarily
-  uniform, exhaustive, or formal, in that they defer detailed elaboration of
-  low-risk software elements and avoid unnecessary breakage in their
-  design until the high-risk elements of the design are stabilized."
-
-  "Overall, risk-driven documents, particularly spesifications and plans, are
-  importatn features of the spiral model. Grean amount of detail are not
-  necessary unless the absence of such detail jeopardizes the project."
-
-  Boehm, B. (1988). "A spiral model for software development and 
-  enhancement". IEEE Computer 21 (5), pp. 61-72.
-
-- architectural documents as parts of design, redesign and maintenance
-
-  David Lorge Parnas and Paul C. Clements. A rational design process: 
-  How and why to fake it. IEEE TSE, SE-12(2):251--257, February 1986.
-  (couldn't get the original yet :/ not available digitally)
+.. [#] Boehm, B. (1988). "A spiral model for software development and 
+       enhancement". IEEE Computer 21 (5), pp. 61-72.
+
+- architectural documents are important parts of design,
+  redesign and maintenance phases of the design process
 
-  + phases of design process:
+  + faking a rational design process [#]_ (pp. 252-255):
   
-    1) designing and documenting module structure
-    2) designing and documenting module interfaces
-    3) designing and documenting "käyttösuhdehierarkia"
-       (should really get the original document :)
-    4) designing and documentin module inner structures
-    5) implementing
-    6) maintenance, re-design, re-implementing (keeping
-       also document up-to-date) this probably included
-       the importance of good documentation for new-comers
+    A) establish and document requirements
+    B) design and document the module structure
+    C) design and document the module interfaces
+    D) design and document the uses hierarchy
+    E) design and document the module internal structures
+    F) write programs
+    G) maintain (redesign and redevelopment, keeping documentation
+     up-to-date).
 
-- creating UML diagrams to natural part of our design (pegboard) and
-  documenting (architecture docs) process
+  + 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 tools like Rational Rose
+     
+  + trying to get rid of Mythical Man of Month effect [#]_;
+    lowering threshold for new people
 
+.. [#] David Lorge Parnas and Paul C. Clements. A rational design process: 
+       How and why to fake it. IEEE TSE, SE-12(2):251--257, February 1986.
+
+.. [#] F. P. Brooks, JR., The Mythical Man-Month: Essays on Software 
+       Enginering. Reading, MA: Addison-Wesley 1975.
 UML
 ---
 
@@ -136,12 +121,6 @@
    Kalle Lyytinen, Pekka Kerola. (1994). MetaPHOR Project: Final 
    Report. Department of Computer Science and Information Systems. 
    University of Jyvaskyla. <http://metaphor.it.jyu.fi/loppurap/>
-
-This page lists a lot of UML tools:
-http://plg.uwaterloo.ca/~migod/uml.html
-
-Other non-commercial documentation tools:
-http://www.stack.nl/~dimitri/doxygen/links.html
 
 Javadoc
 -------