40. Аж документациясын әзiрлеу.

Документация-мәліметтер мен документтер жинағы.

Программалық жабдықтамаға документация-кейбір программалық жабдықтаманы (ПЖ,программа немесе программалық өнім) қамтитын документтер,және де программаның қалай жұмыс істейтінін немесе қалай қолданылатынын сипаттайды.

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

Документация мазмұны

Жүйенің архитектурасы бойынша документация маңызды, бірақ оның жасалуы әзірлеу процесінің қозғаушы күші болмауы керек: документация –маңызды, бірақ ең басты нәтиже емес.Документация-жанды(нақты) тауар екенін естен шығармауымыз керек, және оған жобаның релиздерімен бірге эволюция жолымен бірте бірте дамуына жағдай туғызу керек.Программа мәтінімен бірге қосалқы документация көптеген формальды және формальды емес тексерулерді өткізу үшін негізгі қызмет атқарады.

Не құжаттандырылу керек? Әлбетте, соңғы қолданушыға ұсынылған документация орнату нұсқауларын және әрбір релиздің қолданылуын қамту керек. Бұдан басқа,көріністердің тізбегінде жүйенің функционалды нүктесінің мағынасын айқындау үшін анализ нәтижелері құжатталуы керек.Сонымен қатар, әзірлеушілер тобының келісімі үшін архитектура және реализация бойынша документация жүргізілуі керек.Және де барлық стратегиялық шешімдер жайлы ақпарат сақтау үшін - бұл жүйенің эволюциясын және бейімделуін жеңілдетеді.

Архитектура және реализация бойынша документация келесілерді сипаттауы керек:

• Жоғарғы деңгейдегі жүйенің архитектурасын;

• Кілттік абстракцияларды және архитектура механизмдерін;

• Жүйенің қарастырылған жағдайының негізгі аспектілерін дәлелдейтін көріністерді.

Объектілі-бағытталған жүйе үшін құруға болатын ең нашар документация бұл - әрбір тәсілдің жеке- жеке класс бойынша жазылған түсініктемелері.Мұндай тәсілдемеде ешкім оқымайтын және оған ешкім сенбейтін керек емес қағаздардың жиыны болып шығады.Сонымен қатар, класстар және объектілер бірлестігінде көрінетін және шеттен шығатын жеке класстардың маңыздырақ архитектуралық шешімдері жоғалуы мүмкін.Жоғарыда сипатталған бұл жоғарғы деңгейдің құрылымын диаграммалар тілінде құжаттау жақсырақ, бірақ программалау тілінің ашық операторларының көмегінсіз. Және әзірлеушілерге арналған тактикалық бөлшектерді анықтау үшін маңызды класстардың интерфейстеріне сілтемелер жасау жақсырық болып табылады.