A szoftver dokumentáció típusai

Tartalomjegyzék:

Anonim

Ha valaha láttál számítógépes könyvtárat a cégedben a "szoftverdokumentumok" vagy "szoftver-útmutatók" nevű hálózati meghajtónál, majd megnézte a megtekinteni kívánt dokumentumokat, valószínűleg rájött, hogy a szoftverek dokumentumai és típusai vannak. számos. Úgy tűnik, hogy egyes dokumentumok egy kategóriába tartoznak más kategóriákra is. A szoftverdokumentumokat egy tipikus szoftver életciklusának minden szakaszában használják, így jó hely a létrehozott dokumentumok típusának vizsgálatához.

Javaslat

A szoftveres javaslat meghatározza a szoftverrendszer követelményeit, és meghatározza a szoftver célját és a megoldandó problémákat. Meg fogja határozni azt is, hogy mennyi időt vesz igénybe a szoftverprojekt és a javaslatot befolyásoló egyéb tényezők.

Megvalósíthatósági tanulmány

A megvalósíthatósági tanulmány általában a projekt elején történik. Ez a szakasz meghatározza, hogy a szoftverüzem megfelel-e az ügyfél üzleti igényeinek. A megvalósíthatósági tanulmány eredménye azt határozza meg, hogy a projekt folytatódik-e vagy sem.

Követelmények elemzése

A követelmények elemzése biztosítja az üzleti követelmények automatizált szoftveres megoldásokra történő lefordítását. Ezt a feladatot általában külső tanácsadó vagy vállalatirányítás végzi. A követelmények az üzleti követelményeket a hardver, a szoftver és az összetevők tényleges specifikációira fordítják.

Tervezési dokumentumok

A tervezési dokumentumok alapját képezik a szoftverfejlesztés technikai szinten történő megkezdésének. Amint azt a név is sugallja, az adatbázisok, interfészek, kommunikáció, webes fejlesztések és a szoftver egyéb aspektusainak grafikus és szöveges tervezése a kódolás megkezdése előtt megtervezhető.

Kódolási dokumentumok

A dokumentumok kódolása a szoftver programozásához használt tényleges forráskódra vonatkozik. A kód tetszőleges számú rendelkezésre álló számítógépes nyelven írható, beleértve a Java, C ++, PHP és több száz számítógépes nyelvet, a használt rendszertől függően.

Tesztelési dokumentumok

A csapatok és a fejlesztők tesztelési dokumentumokat hoznak létre a szoftver életciklusának különböző szakaszaiban. A fejlesztők egységkódoló dokumentumokat készítenek saját kódjukhoz. A tesztcsapat vagy más, a kóddal közvetlenül nem összefüggő személyek elvégzik az integrációs tesztelést és az üzleti követelmények tesztelését.

Felhasználói útmutatók és marketing

A felhasználói útmutatók útmutatást nyújtanak az új szoftver működéséhez. Ha a rendszer nagy és összetett, a felhasználói útmutatókat általában a személyzet hivatalos képzési tanfolyamai támogatják. A marketing dokumentumok illusztrálják az új szoftverrendszer előnyeit a potenciális ügyfelek számára.

Szoftver licencek

A szoftverlicencek kiadása a végfelhasználót illetően jogszerűvé teszi a szoftvert. A felhasználók a szoftvert a szerzői társaság által kiadott szoftverlicenc feltételei szerint használják. Nem minden szoftver rendelkezik szigorú licencelési feltételekkel, és ez különösen igaz a nyílt forráskód esetében. Általában a szoftverrendszerek rendelkeznek valamilyen licencdokumentummal, amely meghatározza, hogyan és hol használható a szoftver.