171 |
+ when only following dummy link into some part of |
+ when only following dummy link into some part of |
172 |
javadoc tree, we would lost the class' context in the architecture |
javadoc tree, we would lost the class' context in the architecture |
173 |
documentation we started |
documentation we started |
174 |
Advantage over paper: MARGINAL: automatize cross-indexing |
|
175 |
|
Advantage over paper: MARGINAL: automatize cross-indexing |
176 |
|
|
177 |
Step 2; embedding UML-diagrams into javadoc, linking also them |
Step 2; embedding UML-diagrams into javadoc, linking also them |
178 |
"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" |
"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" |
179 |
|
|
180 |
+ though, this is not yet enough, because we want to know |
+ though, this is not yet enough, because we want to know |
181 |
where classes are referred in architecture documentation |
where classes are referred in architecture documentation |
|
+ "focus+context menu"-metaphor for diagrams needs that we can |
|
|
"step back" from class documentation back to architecture |
|
|
documentation |
|
182 |
|
|
183 |
+ infuriating to the user that the diagram allows navigation |
+ infuriating to the user that the diagram allows navigation |
184 |
between *almost* all contexts it is shown in. |
between *almost* all contexts it is shown in. |
185 |
|
|
186 |
+ diagrams a little cluttery |
+ diagrams a little cluttery |
187 |
|
|
188 |
Advantage over paper: SOME: see the contexts of a class, |
Advantage over paper: SOME: see the contexts of a class, |
189 |
traverse them |
traverse them |
190 |
|
|
191 |
Step 3; backlinks to the architecture documentation |
Step 3; backlinks to the architecture documentation |
192 |
""""""""""""""""""""""""""""""""""""""""""""""""""" |
""""""""""""""""""""""""""""""""""""""""""""""""""" |
193 |
|
+ "focus+context menu"-metaphor for diagrams |
194 |
|
|
195 |
|
+ we highlight the "focused" element |
196 |
|
of the diagram |
197 |
|
|
198 |
|
+ we can |
199 |
|
"step back" from class documentation back to architecture |
200 |
|
documentation. |
201 |
|
|
202 |
+ all this (UML and rerer backlinks) drawn into diagram for consistency |
+ all this (UML and rerer backlinks) drawn into diagram for consistency |
|
Advantage over paper: MAJOR: multi-end links easily traversable, |
|
|
structure can be understood |
|
203 |
|
|
204 |
+ because we can now go to the architectural document from the javadoc, |
+ because we can now go to the architectural document from the javadoc, |
205 |
we can reduce the size of the diagram in the javadoc by 50%. |
we can reduce the size of the diagram in the javadoc by 50%. |
206 |
|
|
207 |
|
Advantage over paper: MAJOR: multi-end links easily traversable, |
208 |
|
structure can be understood |
209 |
|
|
210 |
|
|
211 |
Documentation's developer's point of view |
Documentation's developer's point of view |
212 |
----------------------------------------- |
----------------------------------------- |
213 |
|
|