100 |
|
|
101 |
.. (and other aids for our software development) |
.. (and other aids for our software development) |
102 |
|
|
|
.. generally about these by-products |
|
|
|
|
103 |
Navidoc is a collection of lightweight tools built to support our |
Navidoc is a collection of lightweight tools built to support our |
104 |
project's documentation. Navidoc expands UML diagrams embedded in |
project's documentation. Navidoc expands UML diagrams embedded in |
105 |
design documentation to work as multi-ended links, which |
design documentation to work as multi-ended links, which |
107 |
documentation. For describing UML diagrams, Navidoc provides a |
documentation. For describing UML diagrams, Navidoc provides a |
108 |
readily-authored lexical language, which can be written within |
readily-authored lexical language, which can be written within |
109 |
design documentation. The example of Navidoc enhanced documentation |
design documentation. The example of Navidoc enhanced documentation |
110 |
couldbe found at http://himalia.it.jyu.fi/gzzdoc/ |
could be found at http://himalia.it.jyu.fi/gzzdoc/ |
111 |
|
|
112 |
.. test system (moving towerds XP, meaning of unit test in it, |
.. - developed as byproduct |
113 |
tools for lowering the threshold of writing test) |
* components/features added when needed |
114 |
|
- Navidoc |
115 |
|
* linking different documentations via UML diagrams |
116 |
|
+ design documentation |
117 |
|
+ javadoc |
118 |
|
+ lexically described UML diagrams within design documentation |
119 |
|
+ postprocessing html files, adding imagemaps and images, |
120 |
|
creating crosslinks/backlinks |
121 |
|
* Gzz's documentation in himalia as example |
122 |
|
- built especially to fit for our needs, to fit and support |
123 |
|
our software development process |
124 |
|
* usable with any text editor |
125 |
|
* use of open software toolchain |
126 |
|
- using reStructuredText |
127 |
|
* documentation and code could be written with same tools |
128 |
|
* "language" could be expanded with directives |
129 |
|
* describing diagrams lexically within documentation |
130 |
|
* describing diagrams is easy, placing could be difficult |
131 |
|
* (pegboard) |
132 |
|
* (latex writer) |
133 |
|
- test framework |
134 |
|
* adopting XP, importance of writing tests |
135 |
|
* framework minimizes the gap of writing and running test |
136 |
|
|
137 |
Vesa Kaihlavirta |
Vesa Kaihlavirta |
138 |
|
|