Felhasználói eszközök
oktatas:programozas:dokumentacio
Különbségek
A kiválasztott változat és az aktuális verzió közötti különbségek a következők.
| Következő változat | Előző változat | ||
|
oktatas:programozas:dokumentacio [2019/08/22 12:38] admin létrehozva |
oktatas:programozas:dokumentacio [2022/09/11 22:08] (aktuális) admin [Automatikus dokumentáció] |
||
|---|---|---|---|
| Sor 2: | Sor 2: | ||
| ====== Dokumentáció ====== | ====== Dokumentáció ====== | ||
| - | ===== A felhasználói dokumentációról ===== | ||
| - | A felhasználói dokumentáció többféle médián megjelenhet: | + | * **Szerző:** Sallai András |
| + | * Copyright (c) Sallai András, 2021, 2022 | ||
| + | * Licenc: [[https://creativecommons.org/licenses/by-sa/4.0/|CC Attribution-Share Alike 4.0 International]] | ||
| + | * Web: https://szit.hu | ||
| + | |||
| + | |||
| + | ===== A dokumentációk médiái ===== | ||
| + | |||
| + | A dokumentáció többféle médián megjelenhet: | ||
| * papír | * papír | ||
| * elektronikus | * elektronikus | ||
| Sor 15: | Sor 22: | ||
| - | ===== Felhasználói dokumentáció vázlatosan ===== | + | |
| + | ===== 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: | ||
| + | * https://en.wikipedia.org/wiki/Comparison_of_documentation_generators (2022) | ||
| + | ==== 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 ==== | ||
| Sor 107: | Sor 160: | ||
| === Ismert hibák === | === Ismert hibák === | ||
| Az ismert hibák leírása. | Az ismert hibák leírása. | ||
| - | |||
| - | |||
| - | ===== Fejlesztői dokumentáció vázlatosan ===== | ||
| - | |||
| - | * specifikációk | ||
| - | * futási környezet | ||
| - | * fejlesztői környezet | ||
| - | * algoritmusok és adatok | ||
| - | * szabványok | ||
| - | * tesztek | ||
| - | * hatékonysági mérések | ||
| - | * fejlesztési lehetőségek | ||
| - | * a készítő adatai | ||
oktatas/programozas/dokumentacio.1566470297.txt.gz · Utolsó módosítás: 2019/08/22 12:38 szerkesztette: admin
Hacsak máshol nincs egyéb rendelkezés, ezen wiki tartalma a következő licenc alatt érhető el: CC Attribution-Share Alike 4.0 International
