143 |
It is not a new idea to use UML diagrams in documentation |
It is not a new idea to use UML diagrams in documentation |
144 |
navigation. There already exists Javadoc like documentation generation |
navigation. There already exists Javadoc like documentation generation |
145 |
tools, which generate automaticly classdiagrams from program source |
tools, which generate automaticly classdiagrams from program source |
146 |
code to help navigation in generated documentation. Doxygen |
code to help navigation in generated documentation. |
147 |
[heesch03doxygen]_ ,for example, generates diagrams of class |
Doxygen [heesch03doxygen]_, |
148 |
|
for example, generates diagrams of class |
149 |
inheritance tree for that purpose. |
inheritance tree for that purpose. |
150 |
|
|
151 |
Of course, generated documentation may give well detailed information |
Of course, generated documentation may give well detailed information |
156 |
created diagrams in our design documentation. |
created diagrams in our design documentation. |
157 |
|
|
158 |
- how are UMLs embedded into documentation |
- how are UMLs embedded into documentation |
159 |
|
|
160 |
* using lexical UML language |
* using lexical UML language |
161 |
|
|
162 |
- why lexical UML language: |
- why lexical UML language: |
163 |
|
|
164 |
* no need for additional tools, when writing documentation |
* no need for additional tools, when writing documentation |
165 |
|
|
166 |
* describing is fast |
* describing is fast |
167 |
|
|
168 |
* setting layout may be more |
* setting layout may be more |
169 |
|
|
170 |
.. Embedding diagrams into HTML |
.. Embedding diagrams into HTML |
175 |
Java source code. |
Java source code. |
176 |
|
|
177 |
- why html |
- why html |
178 |
|
|
179 |
* platform and software independent documentation |
* platform and software independent documentation |
180 |
|
|
181 |
* could be distributed in WWW, intranets etc... as it is |
* could be distributed in WWW, intranets etc... as it is |
182 |
|
|
183 |
- why Free Software |
- why Free Software |
184 |
|
|
185 |
* good tools exist already for parts of toolchain |
* good tools exist already for parts of toolchain |
186 |
|
|
187 |
* availibility |
* availibility |
188 |
|
|
189 |
* openess (parts of docutils is overwritten - implementation |
* openess (parts of docutils is overwritten - implementation |
190 |
not possible / more difficult without open code) |
not possible / more difficult without open code) |
191 |
|
|
192 |
* ideology |
* ideology |
193 |
|
|
194 |
* cheapness |
* cheapness |
195 |
|
|
196 |
- pictures? |
- pictures? |
197 |
|
|
198 |
- current implemention state |
- current implemention state |
199 |
|
|
200 |
* created under gzz |
* created under gzz |
201 |
|
|
202 |
* separated as navidoc |
* separated as navidoc |
203 |
|
|
204 |
Usage |
Usage |
205 |
===== |
===== |
206 |
|
|
207 |
- does it really work |
- does it really work |
208 |
|
|
209 |
* WWW statistics from himalia, some comparison |
* WWW statistics from himalia, some comparison |
210 |
between pages containing UML and pages that |
between pages containing UML and pages that |
211 |
does not contain |
does not contain |
212 |
|
|
213 |
* what does the previous prove? |
* what does the previous prove? |
214 |
|
|
215 |
Conclusion |
Conclusion |