Felhasználói eszközök

Eszközök a webhelyen


oktatas:programozas:dokumentacio

< Programozás

Dokumentáció

A dokumentációk médiái

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

  • papír
  • elektronikus
    • PDF
    • HTML
    • 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
    • CLI, GUI
    • 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.

Programok:

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

Cél

A termék helye

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

Komponensek

Például:

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

A használat előnyei

Például:

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

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
  • van-e túlterhelés, mi terhel túl
Adat biztonság
  • Az adatokhoz fizikailag hogyan férhetnek hozzá?
  • Titkosítva van-e.

Teljesítmény

  • 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ó, segítség

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

Felhasználói környezet

Például:

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

Ismert hibák

Az ismert hibák leírása.

oktatas/programozas/dokumentacio.txt · Utolsó módosítás: 2022/09/11 22:08 szerkesztette: admin