Dokumentálás

avagy útmutatók készítése

Fejlesztői dokumentáció

A szoftver belső működését taglalja, hogy más programozók könnyen tudják továbbfejleszteni azt.

Tartalma

• Specifikáció
• Algoritmusok
• Programnyelv verziószám
• Kód
• Tesztesetek
• Környezeti leírás (szg, op.rendszer, memória, perifériák)
• A készítő adatai

Felhasználói dokumentáció

A felhasználók (vagy üzembehelyezők, betanítók) számára készül, hogy tudják használni a szoftvert.

Tartalma

• A feladat leírása
• Környezetleírás
• Telepítés, üzembe helyezés leírása
• Használat leírása (kérdések, lehetséges válaszok, képernyők)
• Bemenő adatok, eredmények
• Mintaalkalmazás
• Hibaüzenetek, annak okai, kezelése