340 |
Documentation's developer's point of view |
Documentation's developer's point of view |
341 |
----------------------------------------- |
----------------------------------------- |
342 |
|
|
343 |
|
+ HTML/WWW browsers don't support bi-directional links |
344 |
|
|
345 |
Goals: |
Goals: |
346 |
|
|
347 |
- small, incremental changes to existing javadoc / other documentation |
- small, incremental changes to existing javadoc / other documentation |
348 |
|
|
349 |
- Low threshold for writing new documentation, diagrams etc. |
- Low threshold for writing new documentation, diagrams etc. |
350 |
|
|
351 |
- minimun barrier to drawing a even small diagram to make |
- minimun barrier to drawing a even small diagram to make |
352 |
document more clear |
document more clear, and to new documents |
353 |
|
|
354 |
|
- "feeling" that the arch. doc will be read(!) |
355 |
|
|
356 |
- link diagrams' objects to code documentation, which |
- link diagrams' objects to code documentation, which |
357 |
they represent |
they represent |
361 |
|
|
362 |
- if diagrams try to link objects, which don't exist (e.g. removed |
- if diagrams try to link objects, which don't exist (e.g. removed |
363 |
Java class), the linking objects will be specially marked |
Java class), the linking objects will be specially marked |
364 |
e.g. colored red |
e.g. colored red, or an error when compiling will be given |
365 |
|
|
366 |
- make diagrams work as context+focusing menus to the code documentation |
|
367 |
|
|
368 |
|
Analysis from a hypertext theory point of view |
369 |
|
============================================== |
370 |
|
|
371 |
UML diagram of how architectural documents, UML diagrams and javadoc |
UML diagram of how architectural documents, UML diagrams and javadoc |
372 |
pages work. Instead of browsing only in one direction, all associations |
pages work. Instead of browsing only in one direction, all associations |
373 |
shown in the diagram should be browsable in either direction! |
shown in the diagram should be browsable in either direction! |
374 |
|
Show instances of arch. docs, javadoc pages &c. Show both diagram and |
375 |
+ HTML/WWW don't support bi-directional links |
then the final hypertext view. |
376 |
|
|
377 |
UML diagrams act as multi-ended nexus links, bringing together all |
UML diagrams act as multi-ended nexus links, bringing together all |
378 |
documents they relate to. They function like navigation bars on the |
documents they relate to. They function like navigation bars on the |
379 |
WWW, except that the same page may have several of them. |
WWW, except that the same page may have several of them. |
380 |
|
|
381 |
Analysis from a hypertext theory point of view |
- make diagrams work as context+focusing menus to the code documentation |
|
============================================== |
|
382 |
|
|
383 |
- Borges's "taxonomy" for animals; |
- Borges's "taxonomy" for animals; |
384 |
http://www.multicians.org/thvv/borges-animals.html |
http://www.multicians.org/thvv/borges-animals.html |