Dasturiy injiniring haqida tushuncha bering

62 Dasturiy ta’minotni hujjatlashtirish

Hujjat - hujjat elementi: ma'lum bir auditoriya uchun mo'ljallangan, ma'lum bir vositada (masalan, kitobda, diskda, tezkor ma'lumotnomada) berilgan formatda joylashtirilgan maqsadli ma'lumotlar .

Dasturiy hujjatlar - maqsadiga qarab, dastur yoki dasturiy ta'minotni ishlab chiqish, ishlab chiqarish, ishlatish, texnik xizmat ko'rsatish uchun zarur bo'lgan ma'lumotlarni o'z ichiga olgan hujjatlar .

Dasturiy ta'minot hujjatlari - chop etilgan foydalanuvchi qo'llanmalari, onlayn (operatsion) hujjatlar va dasturiy mahsulotdan qanday foydalanishni tavsiflovchi yordamchi matn . Dasturiy hujjatlarning to'rtta asosiy turi mavjud:

• 
  me'moriy / loyihaviy - dasturiy ta'minotga umumiy qarash, shu jumladan ish muhitining tavsifi va dasturiy ta'minotni yaratishda foydalanish kerak bo'lgan tamoyillar.
  
• 
  texnik - kod, algoritmlar, interfeyslar, API bo'yicha hujjatlar
  
• 
  foydalanuvchi qo'llanmasi - oxirgi foydalanuvchilar, tizim ma'murlari va boshqa xodimlar uchun qo'llanmalar
  
• 
  Marketing hujjatlari
  
• 
  Dasturiy hujjatlarni qanday yozish kerak
  
• 
  Texnik muallifning asosiy faoliyatlaridan biri bu dasturiy ta'minot uchun texnik hujjatlarni yozishdir.
  

Bunday hujjatlarning xilma-xil turlari mavjud: bu texnik shartlar va sinov usullari, dastur matnlari, qo'llanmalar va foydalanuvchi uchun barcha turdagi yordamlar. Bunday hujjatlardan qulay foydalanish uchun uning hajmi qisqa, mazmuni bilan ahamiyatli va to'liq ma'noda bo'lishi kerak.