Návod -> Inštalačný manuál

Inštalačný manuál je súčasťou používateľskej príručky. V niektorých prípadoch však môže byť uvádzaný samostatne. Musí uviesť presné poradie príkazov potrebných pre úspešnú inštaláciu. Medzi hlavné časti inštalačného manuálu patria požiadavky na technické prostriedky, požiadavky na programové prostriedky a vlastná inštalácia komponentu. Okrem toho obsahuje aj stručný opis funkcie programu. Dodáva sa spolu s programom na inštalačnom médiu, alebo sa umiestni na SVN spolu s ostatnými dokumentmi. Zvyčajne býva vo formáte TXT, PDF alebo vo forme wiki článku.

Požiadavky na technické prostriedky obsahujú minimálne požiadavky a môžu obsahovať aj odporúčané požiadavky. Požiadavky sa kvôli prehľadnosti píšu v zozname, ktorý by mal obsahovať tieto položky:

Požiadavky na technické prostriedky

• Frekvencia a typ procesora
• Operačná pamäť
• Priestor na disku
• Typ a pamäť grafickej karty
• Sieťová karta
• Iné prídavné zariadenia

Požiadavky na programové prostriedky opisujú potrebné softvérové vybavenie počítača pre správny beh programu. Tento zoznam obsahuje tieto položky, nevyplnené položky sa vôbec neuvádzajú:

Požiadavky na programové prostriedky

• Operačný systém
• Obslužné programy, aplikácie
• Knižnice
• Databázy
• Práva na používanie určitého programu

Vlastná inštalácia

V kapitole vlastná inštalácia sa podrobne popíše proces inštalácie softvérového komponentu. Všetky situácie, ktoré môžu nastať, musia byť opísané. Ak je opis rozsiahlejší, člení sa na očíslované podkapitoly. Keď inštalácia prebieha v sérii dialógových okien, je vhodné tieto okná zachytiť v obrázkoch. Tie sa v poradí, v akom prebieha inštalácia vložia do manuálu. A pripojí sa k nim opis so všetkými voľbami, ktoré okno ponúka. Podľa typu komponentu sa v tejto časti inštalačného manuálu môže nachádzať aj postup pre vytvorenie potrebných databáz a tabuliek, respektíve ich presnú štruktúru.

Niekoľko ukážok:

• ArpmonManual
• BmIDSManual
• LogAnalyzerManual

-- MiroslavPorada - 08 May 2011