/[gzz]/manuscripts/presentations/nortti03/navidoc-esitys.rst
ViewVC logotype

Diff of /manuscripts/presentations/nortti03/navidoc-esitys.rst

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 1.1 by tuukkah, Mon May 26 21:52:32 2003 UTC revision 1.2 by humppake, Mon May 26 23:29:25 2003 UTC
# Line 2  Line 2 
2  Navidoc - linkitystä UML-kaavioilla  Navidoc - linkitystä UML-kaavioilla
3  ===================================  ===================================
4    
5  * Navidoc kehittyy projektimme dokumentointitarpeiden pohjalta  .. $Id$
6    
7    * RST-tiedostojen kääntö HTML:ksi  http://www.nongnu.org/navidoc/
8    * UML-diagrammien kuvaus  
9    * diagrammien lisääminen Javadoc-sivuille  - Navidoc kehittyy projektimme dokumentointitarpeiden pohjalta
10    * LibPaperin taustakuvien lisäys www-sivuille  
11      * ReST-tiedostojen__ kääntö HTML:ksi ja LaTeX:ksi (Docutils_)
12      * UML-diagrammien kuvausten tulkinta ja käännös
13      * UML-diagrammien imagemap-linkitys HTML-sivuille
14      * diagrammien lisääminen Javadoc ja Doc++ -sivuille
15    
16    .. _Docutils: http://docutils.sourceforge.net/
17    .. _ReST: http://docutils.sourceforge.net/rst.html
18    __ ReST_
19    
20      * LibPaperin_ taustakuvien lisäys www-sivuille
21    * navigointipalkin lisäys www-sivuille    * navigointipalkin lisäys www-sivuille
22    
23  * käyttötapaus:  .. _LibPaperin: http://himalia.it.jyu.fi/paperbot/paper
24    
25    * suunnittelija selittää ohjelmistoarkkitehtuuriaan muille  - UML-kaaviot voivat toimia valikkoina
26    
27    * suunnittelija kirjoittaa UML-kuvauksen RST-tiedostoon    * kaaviot pitäisi kuitenkin tehdä, tästä lisämotivaatiota
28      * hyviin kaavioihin on abstrahoitu oleellisin
29      * hyvät kaaviot ovat hyviä valikoita, koska ne noudattavat
30        esimerkiksi Millerin kultaista 7+-2 -muistisääntöä
31      * muutenkin hyvät kaaviot ovat selkeitä ja karttamaisia
32      * miksi ei?
33    
34    * Navidoc kääntää diagrammin PNG-tiedostoksi WWW-sivulle  - Navidoc ei toimi yksin, vaan hyödyntää valmiita sovelluksia
35    
36    * ohjelmistoa toteutetaan hajautetusti    * Docutils (*UML-kuvaus omana direktiivinä*)
37      * Metapost (*UML-kuvauksen kääntö kuvaksi*)
38      * pstopnm (*kuvan muunto haluttuun muotoon*)
39      * pnmtopng
40    
41    * diagrammi toimii linkkinä toteutettujen luokkien kuvauksiin  - käyttötapaus:
42    
43      * suunnittelija selittää ohjelmistoarkkitehtuuriaan muille
44      * suunnittelija kirjoittaa UML-kuvauksen RST-tiedostoon
45        muun arkkitehtuuria selittävän tekstin väliin
46      * Navidoc kääntää diagrammin PNG-tiedostoksi WWW-sivulle
47    * luokkakuvauksen yhteydessä diagrammi selventää arkkitehtuuria    * luokkakuvauksen yhteydessä diagrammi selventää arkkitehtuuria
48      * diagrammi toimii linkkinä toteutettujen luokkien kuvauksiin
49      * luokista diagrammi toimii linkkiä käyttökuvaukseen
50        arkkitetuuridokumentaatiossa
51    
52      * ohjelmistoa toteutetaan hajautetusti
53      * diagrammi yhdistää tarvittaessa eri moduuleissa
54        toteutetut luokat
55    
56    - dokumentointi on usein tylsä työtehtävä
57    
58  * dokumentointi on usein tylsä työtehtävä    * tekstipohjainen UML-kuvaus on nopea kirjoittaa keskustelun myötä tai
59        arkkitehtuurikuvauksen ohessa
60    * UML-kaavio on nopea kirjoittaa keskustelun myötä tai arkkitehtuurikuvauksen    * UML-kaavio voidaan luoda samall työkalulla kuin muukin dokumentaatio
61      ohessa      tai ohjelmakoodi
62    
63    * kaavio on käytettävä pidempään kuin toteutus:    * kaavion elinikä voi olla pidempi kuin toteutuksen:
64      * kaavio voidaan hahmotella ennen toteutusta      * kaavio voidaan hahmotella ennen toteutusta
65      * vaikka yksityiskohdat muuttuvat, kaavio voi silti olla avuksi      * vaikka yksityiskohdat muuttuvat, kaavio voi silti olla avuksi
   
   

Legend:
Removed from v.1.1  
changed lines
  Added in v.1.2

savannah-hackers-public@gnu.org
ViewVC Help
Powered by ViewVC 1.1.26