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

Legend:
Removed from v.1.3  
changed lines
  Added in v.1.4

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