[Openfirst-cvscommit] [Bug 251] New: Write documentation for new object oriented design of modules

[<bug...@we...>]

http://bugzilla.openfirst.org/show_bug.cgi?id=251

           Summary: Write documentation for new object oriented design of
                    modules
           Product: openFIRST
           Version: unspecified
          Platform: PC
        OS/Version: All
            Status: NEW
          Severity: normal
          Priority: P2
         Component: www
        AssignedTo: de...@op...
        ReportedBy: ti...@op...


Prepare some nice developer-oriented documentation for the design of modules.

Suggested ways of doing this include:

1. Use Dia (http://www.gnome.org/projects/dia/ -- available for
Linux/Windows/others at that URI) to produce diagrams of database structure and
interactions.  The latest version is much nicer to use than previous versions;
see the UML tool box in Dia.
2. Use Dia to produce diagrams demonstrating visually the interactions between
the assorted modules/systems/what not in order to explain how things work in a
general sense rather than having to look at the code to see specifics.
3. Produce table structure diagrams in HTML; hint: running the mysql client with
the --html switch makes it output HTML versions of table structure (if necessary
these could be converted to XHTML via tidy after being inserted into the overall
documentation page).



------- You are receiving this mail because: -------
You are the assignee for the bug, or are watching the assignee.