A szoftver dokumentációjának szabványai - a szoftvertermék szabványosítása -
A programdokumentáció létrehozása fontos lépés, mivel a felhasználó a dokumentációval megismerkedik a szoftver termékével. Mi a szoftver termék? hogyan kell telepíteni egy szoftverterméket, hogyan kell elkezdeni vele dolgozni - ezek azok az első kérdések, amelyekre a szoftver dokumentációja (Telepítési útmutató, Első lépések) válaszol. A programdokumentáció összeállítását általában speciális személyek kezelik - műszaki írók (néha a programozók programozók vagy elemzők írják magukat). Ez a szakasz a leginkább kellemetlen és nehéz a programozási munkában. Sajnos ez általában nem tanult, vagy a legjobb esetben nem figyeli a kapott dokumentumok minőségét. Ennek ellenére a művészet birtoklása az egyik legfontosabb tényező, amely meghatározza a programozó minőségét.
A helyesen kinyomtatott (pontosabban létrehozott) szoftverdokumentáció csomag sok problémát megtakarít. Különösen a bosszantó kérdéseket és az indokolatlan követeléseket lehet megszabadítani, egyszerűen elküldve a felhasználót a dokumentációba. Ez elsősorban a legfontosabb dokumentumra vonatkozik - a feladatmeghatározásra. Emlékeztethet az IBM ellen többmilliós pert, amelyet egy nagy kiadó mutatott be, ami nem elégedett a számítógépek és a szoftverek minőségével. Az IBM bíróság csak azért nyert, mert bemutatta a mindkét fél által aláírt feladatmeghatározást. Réges-régen, a 20. század 70-es éveiben, de az ügy lényege nem változtatja meg. Nyugaton a szoftverdokumentáció fontosságát már régebben megértették, a szoftverrel együtt egy teljes dokumentációs csomagot szállítottak.
Ha egy programozó-fejlesztő egy formában, vagy egy másik programozási feladathoz érkezik, előtte a projektmenedzser és az egész projektcsapat a következő kérdésekkel néz szembe:
• Mit kell tenni a programon kívül?
• Mit és hogyan kell dokumentálni?
• Mit kell átadnom a felhasználóknak és mi a kíséretszolgálat?
• Hogyan kell kezelni az egész folyamatot?
• Mi tartozik a programozási feladathoz?
Ezeket és más kérdéseket egyszerre válaszolták meg a szoftverdokumentáció állami szabványai - a 19-es sorozat GOST ESDP szabványainak egy csoportja. De még akkor is, a programozóknak sok követelése volt ezeknek a szabványoknak. Valamit sokszor meg kell duplázni a dokumentációban (mint kiderült - indokolatlanul), de sokat nem nyújtottak, például az integrált adatbázisokkal dolgozó programok dokumentálásának sajátosságait.
Sok év telt el, a programozás teljesen új technológiák környezetében zajlik, sok programozó, akik a drag-and-drop stílusban dolgoznak, évek óta nem látják programjaik szövegét. Ez nem jelenti azt, hogy eltűnt a dokumentálási igény. A szoftverfejlesztés ezen oldalát szabályozó legalább néhány rendszer elérhetőségével kapcsolatos kérdéseket folyamatosan kérik.