|
Dasturiy – shuningdek tizim hujjatlari deb ataluvchi hujjatlar – dasturiy ta’minot tuzilishini va uningtuzilmasining tavsiflab beradi. U xatolarni qidirishda yordamlashadi va tizimni o‘zgartirish va kengaytirish uchun zarur ma’lumotlarni taqdim qiladi. Dastur yoki tizim hujjatlari shunchalik to‘la va shunday qurulishi kerak-ki, aloqasi yo‘q, dasturni o‘zi dasturlamagan kishi ham uni tushuna va qayta tiklay olishi mumkin bo‘lsin.
Dasturiy hujjatlar dasturni ishlab chiqarishning eng boshlang‘ich bosqichida boshlangan bo‘lishi va doim dolzarb ahvolda tutilishi kerak. Quyidagi tarkib muhim hisoblanadi:
Dasturiy hujjatlaring muhim tarkibiy qismi, eng avvalo, tizim tasnifidir. U buyurtna haqida masala qo‘yilishidan kelib chiqadi va 2.3 bobda ko‘rsatilgan elementlardan tarkib topadi. Dasturiy hujjatlarninng bu qismi uchun hujjatlashtirishning 3.1 va 3.2 texnikalar (tuzilish diagrammari, diagrammalar, ma’lumotlar oqimining o‘tish tizmasi, ob’ekt munosabat turidagi modellar (ER - modellar) va boshqalar) foydalanishi mumkin.
Hujjatlarning har doim dolzarb holda tutilishi muhim, bu shu demakki, dastur tuzilishida yoki dasturning boshlang‘ich kodida o‘zgarishlar bo‘lganida, ular dasturiy hujjatlarda ham aks etgan bo‘lishi lozim.
Foydalanilgan massiv ma’lumotlarni tavsiflashi, sinovlar natijalarini protokollash va barcha dasturlarni listinglari dasturiy hujjatning asosiy qismi deb hisoblanadi. Ular texnik xizmat ko‘rsatish va dastiriy tizimni modifikasiyalash imkonini baradi va osonlashtiradi.
Ma’lumotlar massivi ularning nomlarini, mundarijasini, yozuv tuzilishini, fayl yaratishni, shuningdek, imkon bolgan yozish va o‘qish amallarini ko‘rsatish orqali tavsiflanadi.
Boshlang‘ich dastur kodi izoh satri yordamida qancha yaxshi hujjatlashtirilgan bo‘lsa, shuncha dasturni tavsifi modul tahlili, parametr va interfeyslarni tavsifi chegaralangan bo‘lishi mumkin.
Umuman olganda dastur hujjatlari qisqa, aniq va ko‘rgazmali bo‘lishi, va albatta u yaratilgan dasturiy ta’minot tizimi to‘liq yoritilgan bo‘lishi kerak.
|
