Szoftver dokumentáció, felhasználói dokumentáció, dokumentáció - a cég

Dokumentáció a szoftvert - kísérő okmányok szoftver (SW) - a program vagy szoftver termék. Ezek a dokumentumok leírják, hogyan működik a program és / vagy hogyan kell használni.

A dokumentáció fontos részét képezi a szoftverfejlesztés, de gyakran elhanyagolt.

Négy alaptípusa dokumentáció szoftver:

• építészeti / design - áttekintést ad a szoftver, beleértve a működési környezet, valamint annak leírását, az elveket, amelyeket fel kell használni, ha a szoftver-
• műszaki - dokumentáció kódot, algoritmusok, interfészek, az API
• felhasználó - útmutató a végfelhasználók, a rendszergazdák és egyéb alkalmazottak
• értékesítés

Építészet / tervdokumentáció

Projekt dokumentáció általában ismerteti a termék általában. Anélkül, amelyben leírják, hogyan valamit használunk, akkor valószínűleg megválaszolja a kérdést: „Miért?” Például, a projekt dokumentum a programozó képes leírni a logikai miért ezek a szerkezetek szervezik ezen a módon. Leírja, hogy miért olyan osztály célja egy bizonyos módon, stand szokások, egyes esetekben még adni azt az elképzelést, hogy hogyan lehet majd végrehajtani fejlesztések a jövőben. Mindez benne van a műszaki vagy felhasználói dokumentáció, de ez nagyon fontos a projekt.

műszaki dokumentáció

Ez pontosan mit jelent a kifejezés dokumentációt a legtöbb programozó. Amikor létrehoz egy programot, a kód önmagában általában nem elég. Meg kell adni egy szöveg leírja a különböző aspektusait, amit a csinál. Az ilyen dokumentáció gyakran szerepel közvetlenül a forráskód vagy a vele szállított.

Az ilyen dokumentáció nagyon hangsúlyos technikai jellegű, és elsősorban kimutatására használják, bemutatása API, adatstruktúrák és algoritmusok.

felhasználói dokumentáció

Ezzel szemben a műszaki dokumentáció, elsősorban a kódot, és hogyan működik, csak a felhasználói dokumentáció leírja, hogyan kell használni a programot.

Ha a termék egy szoftver könyvtár, felhasználói dokumentáció és dokumentáció a kódot nagyon közel vannak, szinte egyenértékű. De általában, ez nem az.

Általában a felhasználói dokumentáció egy kézi, amely leírja az egyes funkciók a program, valamint lépéseket követheti ezt a funkciót használni. Jó felhasználói dokumentáció egy lépéssel tovább megy, és utasításokat, hogy mit kell csinálni, ha a problémákat. Fontos, hogy a dokumentáció nem megtévesztő és releváns volt. Management kell egy világos szerkezetű; Nagyon hasznos, ha van egy átfogó tárgymutató. Logikai koherencia és az egyszerűség is fontos.

Három megközelítés a szervezet a felhasználói dokumentációt. Starter Guide (Eng. Bemutatója), a leghasznosabb az új felhasználók, következetesen folytatja a lépések számát, amelyek végrehajtásához használt olyan tipikus feladatokat. Tematikus megközelítés, amelyben minden fejezet a kézi szentelt néhány konkrét témát inkább alkalmas arra, javítja a felhasználói. Az utóbbi, a harmadik megközelítés, a csapat vagy feladat szerveződnek ábécé könyvtár - gyakran jól fogadták a haladó felhasználóknak, akik ismerik azt, amit keres. Felhasználói panaszok általában összefügg azzal a ténnyel, hogy a dokumentáció csupán egyetlen ilyen megközelítés, és ezért kiválóan alkalmas csak egy osztályba felhasználók.

Sok esetben a szoftverfejlesztők korlátozott számú felhasználói dokumentáció csak a beépített súgó rendszer (Eng. Online segítség), amely információkat tartalmaz a parancsok vagy menüpontok. A munka a képzés az új felhasználók, valamint a támogatás javítja a felhasználói jut el saját kiadók, gyakran nyújt jelentős segítséget nyújt a fejlesztőknek.

marketing dokumentáció

1. fen érdeklődés a termék potenciális felhasználói
2. tájékoztassa őket arról, hogy mi teszi a terméket, hogy az megfeleljen az elvárásoknak úgy, hogy lesz
3. megmagyarázni a termék pozícióját képest konkurens megoldások

Egy jó marketing gyakorlat - amely egy szlogen - egyszerű fülbemászó kifejezést, amely szemlélteti, hogy mit akarunk közvetíteni, hogy a felhasználó, valamint jellemző az érzést. amely létrehoz egy termék.

Gyakran előfordul, hogy a termék doboza és egyéb marketing anyagokat adnak világosabb képet a lehetőségeket és módszereket kell használni a programot, mint bármi más.