| version 1.3, 2002/12/11 18:24:27 |
version 1.4, 2003/04/12 10:51:13 |
|
|
| <!-- $Platon: phpWebFileManager/doc/sgml/changelog.sgml,v 1.3 2002/12/03 20:47:37 nepto Exp $ --> |
<!-- $Platon: Platon.SK/doc-projects/soft-doc-sys/sk/introduction.sgml,v 1.3 2002/12/11 18:24:27 nepto Exp $ --> |
| |
|
| <chapter id="introduction"><title>Úvod</title> |
<chapter id="introduction"><title>Úvod</title> |
| |
|
| Line 15 možných spôsobov rýchleho a efektívneho |
|
| Line 15 možných spôsobov rýchleho a efektívneho |
|
| <para> |
<para> |
| |
|
| Základným faktorom, ktorý je treba mať na zreteli, je cielová skupina. Odlišný |
Základným faktorom, ktorý je treba mať na zreteli, je cielová skupina. Odlišný |
| typ informácií je zaujímavý pre bežného užívateľa softvéru, iný pre |
typ informácií je zaujímavý pre bežného používateľa softvéru, iný pre |
| <!-- potenciálneho --> vývojára aplikácie. Tomu treba následne prispôsobiť formu aj obsah |
<!-- potenciálneho --> vývojára aplikácie. Tomu treba následne prispôsobiť formu aj obsah |
| dokumentácie. Preto odlišujeme dva rôzne typy dokumentácie: |
dokumentácie. Preto odlišujeme dva rôzne typy dokumentácie: |
| |
|
| Line 23 dokumentácie. Preto odlišujeme dva rôzne |
|
| Line 23 dokumentácie. Preto odlišujeme dva rôzne |
|
| <para> |
<para> |
| |
|
| <orderedlist numeration="arabic"> |
<orderedlist numeration="arabic"> |
| <listitem><para>Užívateľská dokumentácia</para><para> |
<listitem><para>Používateľská dokumentácia</para><para> |
| |
|
| Bežneho užívateľa spravidla nezaujíma štruktúra softvéru ani jeho vnútorná |
Bežneho používateľa spravidla nezaujíma štruktúra softvéru ani jeho vnútorná |
| implementácia. Nie je preňho dôležité ako sú veci urobené, aké prostiedky a |
implementácia. Nie je preňho dôležité ako sú veci urobené, aké prostiedky a |
| programovacie jazyky boli pri vývoji použité, ale ako v skutočnosti program |
programovacie jazyky boli pri vývoji použité, ale ako v skutočnosti program |
| funguje, ako sa používa a taktiež v akom prostredí a pod akým operačným systémom |
funguje, ako sa používa a taktiež v akom prostredí a pod akým operačným systémom |
| Line 35 vysvetlenie všetkých funkcií a možností |
|
| Line 35 vysvetlenie všetkých funkcií a možností |
|
| </para> |
</para> |
| <para> |
<para> |
| |
|
| Je lepšie, keď je užívateľská dokumentácia písaná niekým iným ako samotným |
Je lepšie, keď je používateľská dokumentácia písaná niekým iným ako samotným |
| autorom programu. Ten totiž považuje mnoho vecí za úplne jasné a samozrejmé, |
autorom programu. Ten totiž považuje mnoho vecí za úplne jasné a samozrejmé, |
| ktoré však už pre bežného užívateľa také jasné a samozrejmé nie sú. Vhodné je, |
ktoré však už pre bežného používateľa také jasné a samozrejmé nie sú. Vhodné je, |
| keď užívateľská dokumentácia obsahuje množstvo príkladov a keď je celkovo |
keď používateľská dokumentácia obsahuje množstvo príkladov a keď je celkovo |
| písaná s vedomím, že ju nebude čítať osoba rozumejúca programovaniu. |
písaná s vedomím, že ju nebude čítať osoba rozumejúca programovaniu. |
| |
|
| </para></listitem> |
</para></listitem> |
| Line 68 Z prechádzajúcich definícií je teda zrej |
|
| Line 68 Z prechádzajúcich definícií je teda zrej |
|
| úplne odlišné. Nie je možné, aby dokumentácia prvého typu nahrádzala druhú alebo |
úplne odlišné. Nie je možné, aby dokumentácia prvého typu nahrádzala druhú alebo |
| opačne. U vývojárskej dokumentácie platí pravidlo písať ju priamo za behu |
opačne. U vývojárskej dokumentácie platí pravidlo písať ju priamo za behu |
| vytvárania programu. Ak sa vnútorná implementácia alebo štruktúra zmení, zmení |
vytvárania programu. Ak sa vnútorná implementácia alebo štruktúra zmení, zmení |
| sa aj príslušná časť dokumentácie. Užívateľskú dokumentáciu je vhodné taktiež |
sa aj príslušná časť dokumentácie. Používateľskú dokumentáciu je vhodné taktiež |
| začať písať čo najskôr, ale až po dosiahnutí aspoň základnej funkcionality |
začať písať čo najskôr, ale až po dosiahnutí aspoň základnej funkcionality |
| programu. |
programu. |
| |
|
Login
Registration
Slovak
![[BACK]](http://cvsweb.platon.sk/icons/back.gif){kind=icon}
![[TXT]](http://cvsweb.platon.sk/icons/text.gif){kind=icon}
![[DIR]](http://cvsweb.platon.sk/icons/dir.gif){kind=icon}
Up to