==================================================================== Bridging Javadoc and design documentation via UML diagram image maps ==================================================================== .. $Id: short-paper.rst,v 1.1 2003/04/11 13:45:39 humppake Exp $ .. short paper == 2 pages, deadline the end of May .. quick googling about keywords given by referee for the long paper Work by Ellis Horowitz and students on SODOS and DOC - [humppake] horowitz85sodos * distinct program for (crosslinked) document management HyperTies system by Osterbye (name is missing Danish accent characters) - [humppake] Osterbye? - [humppake] Scheiderman: http://doi.acm.org/10.1145/317426.317441 Work by Maletic on automatically finding connections among software documents using LSI - [humppake] 'automatically', probably not relewant Berkeley PhD dissertation by Linton on using RDBMS to store program analysis information - [humppake] couldn't find yet Yi-Farn Chen`s CHIME system for linking software documents - [humppake] devanbu99chime * crosslinking source code using html Requirements traceability research - [humppake] couldn't find yet Abstract ======== .. This could still be good: We present a navigational aid for documentation used in software development. Based on using readily-authored UML diagrams as multi-ended links, we hypertexturally connect two distinct areas of documentation: design documents and javadoc program code documentation. Connecting the distinct areas is essential because it could help new developers in getting productive and supports development processes where both design and implementation change continuously. We also describe the lightweight implementation as a supplement to a Free Software toolchain. To achieve bi-directional linking, the implementation after-treats HTML pages generated by other tools, injecting into referred pages links back to the referring imagemap of each UML diagram. Each diagram also servers as a spatial context for navigation within target nodes. - short description about problem: * how to make fragmented documentation connected with minimum additional work - resolving: * using programming language specific tools to generate documentations from source code level * generate higher level design documentation * connect these levels via UML diagrams drawn design documentation - why UML-diagrams would work as menus * human made abstraction of the system * don't link to everywhere, but to the most essential places * UMLs are already natural part of the design documentation - why lexical UML language: * no need for additional tools, when writing documentation - why Free Software * availibility * openess (parts of docutils have been overwritten) * ideology * cheapness - why html * independent from possible CASE-tools * could be distributed in WWW - pictures? - current implemention state * gzz version ready * separate navidoc version coming up - future * fenfire