2 |
Bridging Javadoc and design documentation via UML diagram image maps |
Bridging Javadoc and design documentation via UML diagram image maps |
3 |
==================================================================== |
==================================================================== |
4 |
|
|
5 |
.. short paper == 2 pages, deadline the end of May |
.. abstract of poster for website == 2 pages, deadline the end of May |
6 |
|
|
7 |
.. quick googling about keywords given by referee for the long paper |
.. quick googling about keywords given by referee for the long paper |
8 |
|
|
269 |
* UMLs are already natural part of the design documentation |
* UMLs are already natural part of the design documentation |
270 |
and thus, familiar to development grew reading documentation |
and thus, familiar to development grew reading documentation |
271 |
|
|
|
The implementation in Navidoc |
|
|
============================= |
|
272 |
|
|
273 |
.. Navidoc is a modular tool, lightweight tool |
.. Navidoc is a modular tool, lightweight tool |
274 |
for implementing the above |
for implementing the above |
397 |
|
|
398 |
* separated as navidoc |
* separated as navidoc |
399 |
|
|
400 |
.. Experiences |
Experiences |
401 |
=========== |
=========== |
402 |
|
|
403 |
Statistics from the WWW server of our project show that the |
Statistics from the WWW server of our project show that the |
404 |
UML diagrams |
UML diagrams |
405 |
have been used to traverse between javadoc and design documentation. |
have been used to traverse between javadoc and design documentation. |
406 |
During three months (Jan 03 till end of Mar 03), 9% of all |
During three months (Jan 03 till end of Mar 03), 9% of all |
407 |
design documentation page requests resulted from traversing from the Javadoc pages to |
design documentation page requests resulted from traversing from the Javadoc pages to |
408 |
design documentation via UML diagrams, and 11% of all |
design documentation via UML diagrams, and 11% of all |
409 |
Javadoc page requests resulted from traversing from design documentation to the Javadoc pages |
Javadoc page requests resulted from traversing from design documentation to the Javadoc pages |
410 |
using the imagemapped |
using the imagemapped |
411 |
diagrams. |
diagrams. |
412 |
Unfortunately, the referrer logs did not allow us to |
Unfortunately, the referrer logs did not allow us to |
413 |
identify the use of UML diagrams for navigation |
identify the use of UML diagrams for navigation |
414 |
within javadoc pages or within design documents, because there |
within javadoc pages or within design documents, because there |
415 |
are other links besides the UML diagrams between those pages. |
are other links besides the UML diagrams between those pages. |
416 |
Also, we are unable to say how much of the traffic came from testing |
Also, we are unable to say how much of the traffic came from testing |
417 |
and debugging Navidoc itself and how much from real use. |
and debugging Navidoc itself and how much from real use. |
418 |
Anecdotally, finding the context *is* easier with the UML diagrams. |
Anecdotally, finding the context *is* easier with the UML diagrams. |
419 |
|
|
420 |
|
|
421 |
.. We expect those number would be even higher. |
.. We expect those number would be even higher. |