215 |
.. Javadoc has plenty of unhierarchical links, but they are not meaningful, |
.. Javadoc has plenty of unhierarchical links, but they are not meaningful, |
216 |
they don't give the documentation any structure. |
they don't give the documentation any structure. |
217 |
|
|
218 |
Background |
Background on software development |
219 |
========== |
================================== |
220 |
|
|
221 |
In their article "A rational design process: how and why to fake it" |
In their article "A rational design process: how and why to fake it" |
222 |
[parnas-clements86rational]_ Parnas and Clements argue that rational |
[parnas-clements86rational]_ Parnas and Clements argue that rational |
306 |
intercommunication within our group, we believe manually made human |
intercommunication within our group, we believe manually made human |
307 |
abstracted documentation serves our purposes best. |
abstracted documentation serves our purposes best. |
308 |
|
|
309 |
Setting of problem |
The problem of two separate pieces of documentation |
310 |
================== |
=================================================== |
311 |
|
|
312 |
In our project, as probably in most projects that use Java programming |
In our project, as probably in most projects that use Java programming |
313 |
language [java-ref]_, the software development documentation is |
language [java-ref]_, the software development documentation is |
392 |
documentation and Javadoc, using UML diagrams as multi-ended nexus |
documentation and Javadoc, using UML diagrams as multi-ended nexus |
393 |
links. |
links. |
394 |
|
|
395 |
Design |
The design for bi-directional navigation |
396 |
====== |
======================================== |
397 |
|
|
398 |
.. some references to the screenshots here? |
.. some references to the screenshots here? |
399 |
|
|
562 |
documentation pages and creates backlinks to the initiating documentation |
documentation pages and creates backlinks to the initiating documentation |
563 |
pages. |
pages. |
564 |
|
|
565 |
Implementation |
The software implementation |
566 |
============== |
=========================== |
567 |
|
|
568 |
Eventually, we found no Free Software tools which |
Eventually, we found no Free Software tools which |
569 |
would fulfill our needs. Therefore, we decided to proceed with our own |
would fulfill our needs. Therefore, we decided to proceed with our own |
836 |
|
|
837 |
screenshots |
screenshots |
838 |
|
|
839 |
Conclusion |
Discussion |
840 |
========== |
========== |
841 |
|
|
842 |
In this article we have discussed the hypertextualization of |
In this article we have discussed the hypertextualization of |