Re: [Ganymede Dev] Documentation for developers beyond the one in the web?

[Jonathan Abbey <jonabbey@arlut.utexas.edu>]

On Fri, Aug 30, 2002 at 03:05:14PM +0200, Dirk Jahnke wrote:
| Dear Jonathan Abbey,
| 
| we examined the documentation which could be found at the Ganymede web
| site and installed Ganymede for test purposes.  We got a (good) feeling
| what kind of functionality Ganymede provides and tried to asses, if
| we could use Ganymede for our project.
| 
| After studying the documentation one of our Java experts wants to know,
| if there is any documentation beyond the docs found at the web site?

I'm afraid I did the majority of the Ganymede design on pen and paper.
I have hundreds of pages of paper notes, but currently very little in
the way of electronic documentation above and beyond what is already
on the web site.

I've got a student working now on producing additional documentation,
but this effort hasn't produced anything that would be useful for your
purposes yet.

| He is especially interested to learn about the relations between classes,
| data flow a.s.o.
| 
| Are there documents like
| 
|   * Use Case Docs
|   * workflow- / activity-diagrams (roles / "swimlanes")
|   * interaction (sequences, collaboration,data flow)
|   * class diagrams (incl. relationships)
|   * state charts
| 
| so he can find out about the dependencies between classes and if there
| are implicit assumptions or explicit declarations, dependencies between
| data model and the object database.

If you read the server java docs, there is a hyperlinked explanatory
narrative in the class headers.. starting at

http://tools.arlut.utexas.edu/gash2/doc/javadoc/arlut/csd/ganymede/Ganymede.html

you should be able to follow the links in the class commentary headers
to flow through the class layout of the server, at least, but there's
not really any class relationship diagrams outside of my paper notes.

I'm afraid I'm not personally experienced with most of the forms of
formal documentation you've listed here, however.

| If the Ganymede developers could provide these kind of douments
| we would greatly appreciate it.
| 
| Kind regards,

Incidentally, I've been contemplating your proposed use of Ganymede,
and I've been spending a lot of time thinking about ways to improve
Ganymede's data model and scalability, through the use of something
like Berkeley DB or PostgreSQL and an xml-based delta build system.

If you have suggestions as to tools or methodologies for sketching out
ideas for revisions to the Ganymede data model and implementation, I'd
be interested in taking a look at them, either to explain the current
design to your Java team, or to assist in my work in the evolution of
the design.

| --
| Dirk Jahnke                            IT Systems / Bldg. 2b / Room 221
| DESY Hamburg                           Deutsches Elektronen-Synchrotron
| D-22603 Hamburg                        Notkestrasse 85  / 22607 Hamburg
| Tel: +49-40-899.8.1760    Fax: +49-40-899.4.1760    dirk.jahnke@desy.de

-- 
-------------------------------------------------------------------------------
Jonathan Abbey 				              jonabbey@arlut.utexas.edu
Applied Research Laboratories                 The University of Texas at Austin
Ganymede, a GPL'ed metadirectory for UNIX     http://www.arlut.utexas.edu/gash2

----------------------------------------------------------------------------
To make changes to your subscription to the Ganymede Dev mailing list, send
mail to majordomo@arlut.utexas.edu.

To unsubcribe, include the line

unsubscribe ganymede-dev

in the body of your mail message

Visit the Ganymede web page at http://www.arlut.utexas.edu/gash2

----------------------------------------------------------------------------