15-дәріс. Программалық жабдықтарды құжаттау. Құжаттаудың ортақ жүйесі

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

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

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

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

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

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

⇐ Предыдущая 1 2 3 4 5 6 78