Программалық жабдықтарды құжаттаудың түрлері, талаптары және стандарттары

Орындаған: Нұржанова С.

Тексерген: Жаксыгулова Д. Д.

Программалық жабдықтарды құжаттау оның өмірлік циклындағы маңызды процесстердің бірі болып есептеледі. Программалық жабдықтың құжаттарына баспа түрінде немесе цифрлық түрде дайындалған программаны құрушыға арналған құжаттар, қолданушыға арналған нұсқаулықтар, анықтамалықтар, диалог түріндегі электрондық нұсқаулықтар және т. б. жатады.

МЕМСТ пен бекітілген программалық құжаттаудың түрлері

Архитектуралық - жобалаушы құжаттар, негізінен программаны құрушыларға арналған. Мысалы, архитектура - жобалаушы құжаттарда программисттер деректер құрылымының не себепті класстар түрінде анықталғанын, немесе паттерннің не үшін таңдалғанын, немесе оларды жетілдіру үшін не істеу керек екенін баяндай алады, мұндай мәселелер программалық жабдықтың техникалық құжатына да, қолданушының құжатына да кірмейді;

Техникалық құжаттар программада қолданылған алгоритмдерді, қолданушының интерфейстерін, программаның кодын анықтайтын техникалық сипаттағы құжаттар болып табылады. Қазіргі уақытта программалық жабдықтың техникалық құжатын жасаудың автоматтандырылған жүйелері (мысалы, Doxygen, javadoc, NDoc сияқты құжаттандыру генераторлары) қолданылып жүр;

Қолданушының құжаттары программалық жабдықты кәсіби қызметтерінде пайдаланатын қолданушыларға арналады. Бұл құжатта программалық жабдықты қалай пайдалану қолданушыға түсінікті түрде дәл және толық берілуі тиіс;

Маркетингтік құжаттар программалық жабдықты нарықта насихаттау үшін жасалады. Мұнда көпшіліктің назарын аударатын реклама түріндегі материалдар, программалық жабдықтың артықшылықтары және т. б деректер қамтылады.

Программалық жабдықтарды құжаттаудың ортақ жүйесін Қазақстан Республикасының деңгейінде және халықаралық деңгейде қабылданған стандарттар құрайды. Программалық жабдықтарды құжаттандыруға байланысты Қазақстан Республикасы деңгейінде СТ РК ИСО/МЭК 6592-2002 - « Ақпараттық технологиялар. Компьютерлік қолданбалы жүйелерді құжаттандыру бойынша нұсқаулық», СТ РК ГОСТ Р ИСО/МЭК ТО 16326-2006 - «Бағдарламалық инженерия. Жобаны басқару кезіндегі СТ РК 34. 019 қолдануға нұсқаулық», СТ РК ГОСТ Р ИСО/МЭК 15910-2006 (ГОСТ Р ИСО/МЭК 15910-2002, IDT) - « Ақпараттық технологиялар. Бағдарламалық құралдарды қолданушыға құжат дайындау процессі» және т. б. халықаралық деңгейдегі стандарттар қолданылып жүр.