345 |
- small, incremental changes to existing javadoc / other documentation |
- small, incremental changes to existing javadoc / other documentation |
346 |
|
|
347 |
- Low threshold for writing new documentation, diagrams etc. |
- Low threshold for writing new documentation, diagrams etc. |
|
|
|
|
reST's filosophy |
|
|
|
|
|
- indentation for blocks |
|
|
- robust for erros |
|
|
- "natural" to write |
|
|
- "ASCII layout" (our UML-language is an exception, which is discussed later) |
|
|
|
|
|
Why UML-language |
|
|
|
|
|
- minimum barrier to make a diagram (well, at first have to learn our UML-script) |
|
|
|
|
|
- separate UML structure from presentation, show structure in easily |
|
|
editable text |
|
|
|
|
|
- direct manipulation when building diagrams clumsy |
|
|
|
|
|
- diagrams in the same reST source than the architecture document |
|
|
|
|
|
- only explicit link from diagram object to the class it represents is |
|
|
obligatory, all other are implicit |
|
|
|
|
|
UML diagram component |
|
|
|
|
|
- not strictly necessary; could have used another editor |
|
|
|
|
|
- problem: direct manipulation of UML diagrams very clunky |
|
|
|
|
|
- users are programmers --> allow a simple programming language |
|
|
|
|
|
- placement: currently metapost; looking at ways to make |
|
|
interactively editable. |
|
|
|
|
|
+ elements are easy to create by script language |
|
|
|
|
|
+ graphical placing could need an GUI |
|
|
|
|
348 |
- minimun barrier to drawing a even small diagram to make |
- minimun barrier to drawing a even small diagram to make |
349 |
document more clear |
document more clear |
350 |
|
|
438 |
|
|
439 |
- flow diagram of the implementation |
- flow diagram of the implementation |
440 |
|
|
441 |
|
reST's filosophy |
442 |
|
|
443 |
|
- indentation for blocks |
444 |
|
- robust for erros |
445 |
|
- "natural" to write |
446 |
|
- "ASCII layout" (our UML-language is an exception, which is discussed later) |
447 |
|
|
448 |
|
Why UML-language |
449 |
|
|
450 |
|
- minimum barrier to make a diagram (well, at first have to learn our UML-script) |
451 |
|
|
452 |
|
- separate UML structure from presentation, show structure in easily |
453 |
|
editable text |
454 |
|
|
455 |
|
- direct manipulation when building diagrams clumsy |
456 |
|
|
457 |
|
- diagrams in the same reST source than the architecture document |
458 |
|
|
459 |
|
- only explicit link from diagram object to the class it represents is |
460 |
|
obligatory, all other are implicit |
461 |
|
|
462 |
|
UML diagram component |
463 |
|
|
464 |
|
- not strictly necessary; could have used another editor |
465 |
|
|
466 |
|
- problem: direct manipulation of UML diagrams very clunky |
467 |
|
|
468 |
|
- users are programmers --> allow a simple programming language |
469 |
|
|
470 |
|
- placement: currently metapost; looking at ways to make |
471 |
|
interactively editable. |
472 |
|
|
473 |
|
+ elements are easy to create by script language |
474 |
|
|
475 |
|
+ graphical placing could need an GUI |
476 |
|
|
477 |
|
|
478 |
Practical use |
Practical use |
479 |
============= |
============= |
480 |
|
|