dokumentálása szoftver

előző ◈ a következő

13.1. Dokumentáció létre és használják a folyamat a szoftverfejlesztés

Tervezésekor az SS létre és használják a nagy mennyiségű különböző dokumentumokat. Szükség van olyan eszközként közötti információ továbbítására a fejlesztők az SS-fejlesztési szabályozás azt jelenti, PS és eszközeként információtovábbítás felhasználók alkalmazásához szükséges karbantartási és alállomások. Egy ilyen dokumentáció számlák nagy részét a költségek az alállomás.

Ez a dokumentáció lehet két csoportra oszthatók [13.1]

  • Dokumentumkezelő fejlesztési alállomás.
  • Dokumentumok szerepelnek az alállomás.

A dokumentumok fejlesztési menedzsment PS (szoftver folyamat dokumentáció) ellenőrzött és nyilvántartott folyamatok kialakítása és fenntartása alállomások, kommunikációt biztosító a fejlesztőcsapat és az SS között a fejlesztésben, valamint a vezetők a SS (szoftvermenedzserek) - szervezetek, amelyek ellenőrzik a fejlesztési MS. Ezek a dokumentumok lehetnek a következő típusú [13.1]

  • Tervek, becslések, menetrend. Ezek a dokumentumok által létrehozott vezetők megjósolni, és ellenőrizzék a folyamatok fejlesztése és karbantartása alállomások.
  • Jelentések a források felhasználását a fejlesztési folyamatban. Létrehozta vezetők.
  • Szabványoknak. Ezek a dokumentumok előírják a fejlesztők milyen elvek, szabályok, megállapodások, követnie kell a fejlődési folyamat az SS. Ezek a szabványok lehetnek a nemzetközi vagy nemzeti, valamint speciálisan kialakított a szervezet, amely fejleszti a SS.
  • Munkadokumentumot. Ezek az alapvető műszaki dokumentumokat, amelyek a kapcsolat a fejlesztők. Ezek tartalmazzák a rögzítés a gondolatok és problémák merülnek fel, hogy a fejlesztési folyamatban, leírása alkalmazott stratégiák és megközelítések, valamint a dolgozók (ideiglenes) változat a dokumentumok szerepelnie kell a PS.
  • Notes és a levelezés. Ezek a dokumentumok rögzítik a különböző részleteit közötti kölcsönhatás vezetők és fejlesztők.

    A dokumentumok, amelyek egy részét a PS (szoftver termék dokumentációját). leírja a program az SS, mind azok alkalmazása a felhasználók, mind a fejlesztési és kísérőik (összhangban a célja a SS). Meg kell jegyezni, hogy ezek a dokumentumok fogják használni nem csak abban a szakaszban, amelynek során a SS (annak fázisait alkalmazására és karbantartás), hanem a fejlesztés alatt a kezelési folyamat (beleértve a dolgozó dokumentumok) - minden esetben le kell ellenőrizni őket (tesztelt ) való megfeleléshez a PS programot. Ezek a dokumentumok képezik a két eltérő célja van:

  • Felhasználói dokumentáció a PS (P-dokumentációt).
  • Dokumentáció támogatására a SS (C-dokumentáció).

    13 0,2. Felhasználói dokumentáció szoftver

    Felhasználói dokumentáció a PS (felhasználói dokumentáció) magyarázza a felhasználók hogyan kell eljárni, hogy alkalmazni által kidolgozott PS [13.1, 13.2.]. Szükséges, ha a PS vállal semmilyen felhasználói beavatkozást. Ez magában foglalja a dokumentum, melyek mentén a felhasználó a telepítés során a PS (ha a PS a megfelelő beállítást a felhasználási környezetben az SS), a kérelmet az SS a megoldás a feladataikat és a menedzsment az SS (például amikor kifejlesztette a PS lesz kölcsönhatásba más rendszerek). Ezek a dokumentumok részben érintette alállomás karbantartási problémákat, de nem kapcsolatos kérdésekkel a módosítás a program.

    Készítmény felhasználói dokumentáció függ a közönség a felhasználók, amely orientált által kidolgozott, az SS és a felhasználási módja a dokumentumokat. Kevesebb közönség itt utal a függő PS felhasználók, akik szükség egy adott felhasználói dokumentációt a PS [13.2]. Sikeres egyéni papír alapvetően függ a pontos meghatározása a közönség számára, amelyre azt szánták. A felhasználó dokumentációnak tartalmaznia kell a szükséges információkat minden közönséget. Az alkalmazási mód a dokumentum egy olyan eljárás, amely meghatározza, hogyan használja ezt a dokumentumot. A felhasználó általában csak nagy szoftverrendszerek igényel semmilyen dokumentumot a tanulmány a PS (használja az útmutató), illetve frissíteni néhány információt (használat, mint egy útmutató).

    Összhangban [13.1, 13.2] lehet tekinteni egy tipikus része a következő felhasználó dokumentáció elegendően nagy SS:

  • Általános funkcionális leírása az MS. Ez ad egy rövid leírást a funkcionális képességeit az SS. Felhasználók számára terveztek el kell döntenie, hogy mennyit kell őket, ez alállomás.
  • Beépítési PS vezetés. Szánt PS vezetők. Ez előírják részletesen, hogyan kell telepíteni a rendszert egy adott környezetben, különösen tartalmaznia kell leírását számítógéppel olvasható közeg, amelyen a mellékelt PS fájlok képviselő SS és a követelmények minimális hardver konfiguráció.
  • Használati útmutató SS. Úgy tervezték, a hétköznapi felhasználók számára. Ez tartalmazza a szükséges információkat az alkalmazás a SS szervezett formában kényelmes tanulmányában.
  • Referencia SS Alkalmazás. Úgy tervezték, a hétköznapi felhasználók számára. Ez tartalmazza a szükséges információkat az alkalmazás a SS szervezett formában könnyen szelektíven keresni az egyes részek.
  • FP Management Guide. Szánt PS vezetők. Meg kell leírni a generált üzenetek, amikor az MS együttműködik más rendszerekkel, és hogyan reagálnak ezek a jelentések, a rendszergazda. Ezen felül, ha az SS használja a rendszer hardver, ezt a dokumentumot meg tudja magyarázni, hogyan lehet fenntartani a berendezést.

    Dokumentáció támogató szoftver

    Dokumentációval együtt az SS (rendszer dokumentációját) ismerteti alállomás tekintve fejlődését. Ez a dokumentáció van szükség, ha az alállomás magában foglalja a vizsgálat hogyan van elrendezve (tervezett) és korszerűsítéséhez programokat. Mint már említettük, a támogatást - ez folyamatos fejlődését. Ezért, ha a szükség korszerűsítése az SS ezt a munkát egy különleges csapat a kíséret fejlesztők. Ez a csapat lesz foglalkozni ugyanazt a dokumentációt, amely meghatározza a tevékenységek a csapat kezdeti (alap) alállomás fejlesztők - az egyetlen különbség az, hogy a dokumentációt a command-kíséret fejlesztők hajlamosak furcsa (jött létre egy másik csapat). Ahhoz, hogy megértsük a szerkezet és a fejlesztési folyamat a modernizált alállomások, csapatépítő kíséret fejlesztők tanulmányoznia kell a dokumentációt, és végezze el a szükséges módosításokat, megismételve nagyrészt eljárások, amelyek révén hozta létre az eredeti MS.

    FP támogatási dokumentáció két csoportra oszthatók:

  • dokumentációt, amely meghatározza a szerkezet a programok és struktúrák PS adatok és technológiai fejlesztés;
  • dokumentumokat, amelyek segítenek, hogy módosítsa a alállomás.

    Az első csoport a rekordok tartalmazó végleges dokumentum az egyes eljárási lépés PS fejlődését. Ez magában foglalja a következő dokumentumokat:

  • Megjelenése PS (Követelmények dokumentum).
  • Építészet Leírás PS (leírás a rendszer architektúra), amelyek mindegyike egy külső specifikációját programja (alrendszer).
  • Minden egyes program esetében, az SS - leírását a moduláris felépítés, beleértve a külső specifikáció minden egyes modul tartalmazza azt.
  • Minden egyes modul - a leírásban és az egy struktúra ismertetése (tervezés leírás).
  • modulok szövegek a kiválasztott programozási nyelv (program forráskódját listák).
  • Igazoló iratok megbízhatóságának SS (érvényesítési dokumentumok), amely leírja, hogyan kell létrehozni a valóságnak minden alállomás programok és az információ hogyan létrehozásáról szóló hitelesség követelményeihez kapcsolódó SS.

    Igazoló iratok megbízhatóságának SS tartoznak mindenekelőtt a dokumentáció vizsgálata (tesztelése és leírása megállapított vizsgálatok áramkör), de lehet más típusú ellenőrzés az SS, például az igazolást a program tulajdonságait. Annak érdekében, hogy elfogadható minőségű a dokumentáció hasznos követni általánosan elfogadott irányelvek és szabványok [13,3-13,8].

    Dokumentálása a második csoport tartalmaz

  • támogatására az SS vezetés (rendszer karbantartási útmutató), amely leírja a jellemzőit végrehajtásának SS (különösen a nehézségeket, amelyekkel meg kellett küzdeni), és hogyan kell figyelembe venni a lehetőségét, hogy a fejlődés az SM szerkezete (a design). Azt is rögzítették, hogy mely részek hardver-PS és hardver-függő.

    Gyakori probléma kísérő SS - annak biztosítása, hogy minden ötlete tartott lépést (változzanak), ha az MS változásokat. Annak érdekében, hogy ezt, a kommunikáció és a kapcsolat a dokumentumok és azok részei tükröződnie kell a kézi karbantartás, és rögzíteni kell a konfigurációs adatbázist.

    Gyakorlatok az előadások 13

    13.1. Mi a menedzser egy szoftver?

    13.2. Mi a szokásos felhasználói szoftver eszköz?

    13.3. Mi a rendszergazda szoftver?

    13.4. Mi az útmutató installyatsiiprogrammnogo eszközökkel?

    13.5. Mi az útmutató upravleniyuprogrammnym eszközökkel?

    13.6. Mi vezetés támogatása szoftver eszközök?

    Irodalmi előadás 13

    Tudtad, hogy a telepítési diagram, diagram alkalmazására, forgalomba telepítési diagram diagram - egy módszer az objektum-orientált tervezés, amely bemutatja a fizikai kapcsolatát hardver és szoftver elemek a rendszer.

    Hírek Fórum
    Knights-éter elmélet

    • előző ◈ a következő