Dokumentáció

• Szerző: Sallai András
• Copyright © Sallai András, 2021, 2022
• Licenc: CC Attribution-Share Alike 4.0 International
• Web: https://szit.hu

A dokumentáció többféle médián megjelenhet:

• papír
• elektronikus
  • PDF
  • HTML
  • Hanganyag
  • Videó
  • Kiadvány
  • stb.

• 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

• Mit csinál a program, ki a célközönség
• Futási környezet
• Telepítés
• Használat
  • CLI, GUI
  • bemenő adatok
  • futtatásra példa
• Előforduló hibák futtatáskor, hibaüzenetek
• Korlátok (memória, fájlméret, stb)

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.

A forráskód automatikus dokumentálása.

Programok:

• https://en.wikipedia.org/wiki/Comparison_of_documentation_generators (2022)

Telepítés:

apt install doxygen-gui

Indítás:

doxywizard

Cél

• Ki használja, kit céloz meg.
• Lehetőségek.
• Korosztály.
• A termék haszna.
• A használt technológia haszna.

Például:

• felhasználói nyilvántartás
• üzenetküldési lehetőség
• stb.

Például:

• pontosság (pontos nyilvántartás)
• figyelmeztetések (a rendszer jelez)

• Hogyan juthatunk hozzá?
• Online, CD, Pendrive

• grafikus felület
• parancssoros felület
• interaktív
• stb.

• kilépés
• indítás után mit látunk
• segítség
• következő ablakok

Az egyes felületek áttekinthetősége, célcsoportoknak hogyan felel meg. A felület nyelve. Hagyományos felület, stb.

• azonosítás
• visszaélések kezelése

• van-e túlterhelés, mi terhel túl

• Az adatokhoz fizikailag hogyan férhetnek hozzá?
• Titkosítva van-e.

• terhelt és terheletlen állapotok
• az adatbázis mérete
• nagy vagy kis erőforrásigény
• ajánlott konfiguráció
  • AMD Athlon
  • 512 MB memória
  • 1 GB szabad hely
  • OS független
  • hálózati csatlakozási lehetőség
  • 512 kbit/sec internetelérés vagy gyorsabb

• Dokumentáció, hol, hogyan.
• Segítség, hol, hogyan.

Például:

• számítógép
• érintőképernyő
• Java platform

Az ismert hibák leírása.