A szoftver dokumentációjának fejlesztése
A szoftverdokumentáció referenciaszöveg és vizuális információ, amely leírja és bemutatja a szoftver termék fejlesztési, gyártási, üzemeltetési és karbantartási folyamatát, fogyasztói tulajdonságait és műszaki jellemzőit.
A szoftver dokumentációjának típusai
E meghatározásnak megfelelően a szoftver műszaki dokumentációja négy fő típusból áll:
• Projekt - tartalmazza a szoftver és a munkakörnyezet létrehozásához használt legfontosabb rendelkezések leírását.
• Műszaki - algoritmusok, kódok, interfészek, API.
• Felhasználói útmutatók a program felhasználói számára.
A projektdokumentáció általában a szoftvertermék általános leírása. Például egy programozó programozója igazolhatja, hogy az adatszerkezetek ilyen módon szerveződnek (és nem más módon). Miért ilyen típusú konstrukciót terveztek ilyen vagy más módon. A minták kiemelve vannak a projektben. Gyakran útmutatást ad a program frissítésének módjáról.
Műszaki dokumentáció (mindegyik megrendelhető a TechRightConsult-tól). nem csak konkrét kódokat jelez. Ez általában szabályozza a kód különböző aspektusait is. Ez egyértelműen kifejezett technikai jellegű, és főleg az API-k, algoritmusok és adatstruktúrák leírására és meghatározására szolgál. Az összeállítás során lehetőség van a dokumentációs generátorok (Doxygen, NDoc, javadoc stb.) Használatára, amely lehetővé teszi az ilyen dokumentáció folyamatos naprakész állapotban tartását. Az utóbbi esetben a műszaki dokumentáció a forráskód része. Ezután ugyanazok az eszközök használhatók mind a program összeszerelésére, mind a dokumentáció összeállítására egyidejűleg.
A jó felhasználói dokumentáció a következőkből áll:
• bevezető útmutató, amely általános jellegű feladatokkal foglalkozik;
• tematikus, ahol minden fejezet a program mûködésének egy részének magyarázatára szolgál;
• Ábécé útmutató a tapasztalt felhasználók számára, akik jól tudják, mit keresnek.
Szoftverfejlesztési szabványok
A szoftver termékek dokumentációjának létrehozásának alapja a szabvány.
Ilyen körülmények között az informatikai vállalat különböző módszerekkel határozza meg a szoftver dokumentációjának fejlesztését. Egyesek megpróbálják másolni és végrehajtani a nyugati szabványokat. Egyéb - háztartási használatra. Mégis mások teremtik meg a sajátjukat.
A szoftverdokumentáció fejlesztésének aktuális kérdései
Mindenesetre a szoftver műszaki dokumentációjának kidolgozásának főbb kérdései a következők:
• Mi a szabályozási keret és hogyan kell alkalmazni?
• Milyen dokumentációra van szükség nagy számú dokumentum között?
Fogadjunk részletesebben ezeken a kérdéseken.
Jelenleg a következő dokumentációs szabványok érvényesek:
GOST 19.201 (Unified System of Program Documentation (ETSD);
GOST 34.602 (Az automatizált rendszerek szabványainak összetétele (CCAS).
Emlékeztetni kell arra is, hogy a "technikai szabályozásról" szóló szövetségi törvénynek megfelelően a nemzeti szabványoknak mindig elsőbbséget kell élvezniük a nemzetközi szinten. Vagyis csak akkor lehet nemzetközi szabványokat alkalmazni, ha az utóbbiak nem ellentétesek a nemzetiakkal! Szerencsére a cselekvés szabadsága a hazai normák sokkal inkább idegen. Az utóbbiakat 5-7 évente felülvizsgálják, és pontosabbak, de a meghatározott időtartamra vonatkozó tényleges tapasztalatokat tükrözik. A hazai (nem ilyen fejlett jellemzőkkel) a fogalmi pillanatok mélyreható fejlődése jellemzi. Ez lehetővé teszi számodra, hogy az elvárásoknak megfelelő szabványokat hozzon létre.
A szoftvertermék létrehozásának fő dokumentuma a műszaki feladat, amelyet a program fejlesztésére és tervezésére használnak.
A TOR meg a találkozót a szoftver termék, amely fejlett, technikai jellemzői, a minőség és a műszaki és gazdasági mutatók, valamint a végrehajtására vonatkozó utasításokat a következő lépéseket a dokumentációt (tervezés, szoftver, technológia, stb), annak összetétele és egyéb speciális követelményeket.
A feladatmeghatározás olyan jogi dokumentum, amely mellékletként szerepel a program létrehozására irányuló tervezési munkákra vonatkozó szerződésben, és amely az ilyen megállapodás alapja.
A TK projektvázlatként hajtható végre (a rendszer felépítése és funkciói a megoldás megvalósításának technológiái nélkül kerülnek ismertetésre); és technikai projekt formájában (a kiválasztott technológia részletes leírása a projektek megvalósításához). A TK általánosan is megfogalmazható (például a befektetők számára) és a legrészletesebb részletekkel (a programozók és egyéb esetekben).
Gyakran előfordul, hogy a TK az egyetlen olyan dokumentum, amely leírja a kifejlesztett szoftverterméket. Ilyen esetekben különösen fontos, hogy azokat szakemberek fejlesztik és gyártják.