Ez a dokumentum egy előző változata!
< Programozás
Dokumentáció
A dokumentáció többféle médián megjelenhet:
papír
elektronikus
PDF
-
Hanganyag
Videó
Kiadvány
stb.
Fejlesztői dokumentáció vázlatosan
célok, feladat leírása
fejlesztői környezet (hardver, szoftver)
változók, típusok, adatszerkezetek
algoritmusok
szabványok (ha van)
tesztek
ismert hibák (ha van)
fejlesztési lehetőségek
a készítő adatai
Felhasználói dokumentáció
Mit csinál a program, ki a célközönség
Futási környezet
Telepítés
Használat
-
bemenő adatok
futtatásra példa
Előforduló hibák futtatáskor, hibaüzenetek
Korlátok (memória, fájlméret, stb)
Telepítési útmutató
Nagyobb program esetén írhatunk külön telepítési útmutatót. Kisebb programok esetén része lehet a felhasználói dokumentációnak.
Automatikus dokumentáció
A forráskód automatikus dokumentálása.
Doxygen
Telepítés:
apt install doxygen-gui
Indítás:
doxywizard
Függelék
Felhasználói dokumentációra összetettebb példda vázlatosan
Bevezetés vagy Cél
A termék helye
Komponensek
A használat előnyei
Beszerzés
Hogyan juthatunk hozzá?
Online, CD, Pendrive
Szolgáltatások, jellemzők
grafikus felület
parancssoros felület
interaktív
stb.
Használat
kilépés
indítás után mit látunk
segítség
következő ablakok
Használhatóság
Az egyes felületek áttekinthetősége, célcsoportoknak hogyan
felel meg. A felület nyelve. Hagyományos felület, stb.
Megbízhatóság
Biztonság
azonosítás
visszaélések kezelése
Rendelkezésre állás
Adat biztonság
Teljesítmény
Dokumentáció, segítség
Felhasználói környezet
Például:
számítógép
érintőképernyő
Java platform
Ismert hibák