120 |
them by hand is tedious and error-prone when they are authored using different |
them by hand is tedious and error-prone when they are authored using different |
121 |
software. |
software. |
122 |
|
|
123 |
In this article, we present a navigational aid for software engineering documentation. |
In this article, we present a navigational aid for software documentation. |
124 |
Based on using UML diagrams as multi-ended links, our tool connects two |
Based on using UML diagrams as multi-ended links, our tool connects two |
125 |
distinct areas of software engineering documentation: |
distinct areas of software engineering documentation: |
126 |
the general architectural documents and the detailed method-level javadoc documentation. |
the general architectural documents and the detailed method-level javadoc documentation. |
887 |
|
|
888 |
A collage of screenshots from Gzz project documentation. |
A collage of screenshots from Gzz project documentation. |
889 |
|
|
890 |
a) The "frontpage" of our design documentation. Objects with blue |
a) The front page of our design documentation. Items with blue |
891 |
background are linked, the item describing the active document |
background act as links, the item in orange is the active document, |
892 |
is marked with orange background and "BROKEN LINK" marks that |
and "BROKEN LINK" marks that the item would be a link, but the |
893 |
element is defined to be linked,but the target couldn't be found. |
target was unavailable. |
894 |
b) Moved to "Frontend". The implicitly embedded diagram from the |
b) Moved to "Frontend" documentation node. The diagram from the front |
895 |
front page is included at the top of the page as 50% diminished |
page is |
896 |
version. The element representing active document page "Frontend" is |
implicitly included at the top of the page in small size. |
897 |
in addition to orange background, also rounded with rough edge. |
The item representing this node is marked with rough circling |
898 |
c) Moved to "gzz.client" Javadoc package description page. Several |
in addition to orange background. |
899 |
implicitly embedded diagrams shows the package's context. |
c) Moved to "gzz.client" Javadoc package node. Several |
900 |
d) Moved to "PEG: Viewtool". All diagrams are split in two by |
implicitly embedded diagrams show the various contexts for |
901 |
horizontal line. Below the line is the diagram itself. Above is |
this package. |
902 |
listed the documentation pages, where the diagram is explicitly |
d) Moved to "PEG: Viewtool" documentation node. All diagrams are split |
903 |
included. "PEG" stands for "Proposals for Enchancing Gzz" and |
in two by |
904 |
it's crucial part of our design documentation for future |
horizontal lines. Below a line is the diagram itself, above is |
905 |
|
a list of the documentation nodes where the diagram is explicitly |
906 |
|
included. "PEG" stands for "Proposals for Enchancing Gzz", and |
907 |
|
it's a crucial part of our design documentation for future |
908 |
improvements. |
improvements. |
909 |
|
|
910 |
Discussion |
Discussion |