Here is a message I've just sent to chris davenport, but it might make sens to post it in the forum. I'm professor at the university of grenoble (france) and I've been using joomla for some years now.
I give lectures lectures on software engineering at the graduate level, and I'm about to define a project in which master students will have to contribute documentation for Joomla!1.5. Since this is in the context of a reverse engineering course, they will have to deal with various tools and concepts. They are trained in UML.
The proposal is to create
- an up-to-date set of UML diagram describing the database at the implementation level (that is, with keys and other sql details)
- the same thing at the conceptual level (with associations and higher level of abstraction)
- with links to (site/backend) screens pages.
We use staruml which is a free (windows only :-( ) uml tool. (Students are used to it and it is a commercial-quality tool with no limitation because the company release it as open source before collapsing).
The idea would be to include these images both in the wiki and links in the phpdoc.
Some parts of the are just stubs or do not seems up-to-date and since there are quite disconnected from the api, I'm wondering if it would not be nice to add
links in the docphp documentation so that it refers to the wiki and back
again (with links to the images and to the screens).
1) I would like to know if this make sense to you
2) if there are similar efforts currently (I spent a various hours in the
forum and web site, wiki, but though they are some attempts to have UML
diagrams from time to time, I didn't see if there were some "official" UML diagrams).
3) Will it make sense to submit patches with docbook modification only
(such as adding links in docbook)
4) Do you have some kind of automatic tools to create some part of the wiki
5) I can't find too much information about quality ensurance tools for joomla. I mean they are various tools around to compute metrics, to enforce code style, unit testing, etc. I'm wondering how we can help to get in touch with the right people wrt to that.
I've various classrooms, with about 15 to 20 master students in software
engineering, and since the courses are about software engineering and reverse engineering in practice, I think that working on an open source software like joomla is a good opportunity for them to learn team work and apply their knowledge.
Let me know if this make sense to you, and if you have some pointers ro
relevant information or to people to contact.
May the fun be with you
ps. As you can notice as many other french guys we mostly speak broken english, so the proposal is more about contributing diagrams, traceability links, tools support, etc, rather than writing english prose.
http://megaplanet.org/jean-marie-favre Jean-Marie Favre
Software Language Archeologist and Software Anthropologist
University of Grenoble - LIG - ACONIT - France
Signature rules - Literal URL's Only.