Mundarija:

Manba kodi hujjatlari nima?
Manba kodi hujjatlari nima?

Video: Manba kodi hujjatlari nima?

Video: Manba kodi hujjatlari nima?
Video: TELEGRAM OCHISHDA KOD KELMASA NIMA QILISH KERAK 2024, Noyabr
Anonim

Dasturiy ta'minot hujjatlar kompyuter dasturiy ta'minotiga hamroh bo'lgan yoki o'rnatilgan matn yoki rasm manba kodi . The hujjatlar dasturiy ta'minot qanday ishlashini yoki undan qanday foydalanishni tushuntiradi va turli rollardagi odamlar uchun turli narsalarni anglatishi mumkin. Arxitektura/dizayn - dasturiy ta'minotga umumiy nuqtai.

Buni hisobga olsak, hujjatlarni qanday kodlaysiz?

Hujjatlarni yozish uchun eng yaxshi amaliyotlar:

  1. O'z ichiga olgan README faylini qo'shing.
  2. Boshqalar uchun muammo kuzatuvchisiga ruxsat bering.
  3. API hujjatlarini yozing.
  4. Kodingizni hujjatlashtiring.
  5. Fayllarni tashkil qilish, sharhlar, nomlash qoidalari, dasturlash amaliyoti va boshqalar kabi kodlash qoidalarini qo'llang.
  6. Ishtirokchilar uchun ma'lumotni qo'shing.

Bundan tashqari, foydalanuvchi hujjatlari nima degan savol tug'ilishi mumkin. Foydalanuvchi hujjatlari ga ishora qiladi hujjatlar oxirgi foydalanuvchilarga taqdim etilgan mahsulot yoki xizmat uchun. The foydalanuvchi hujjatlari oxirgi foydalanuvchilarga mahsulot yoki xizmatdan foydalanishda yordam berish uchun mo'ljallangan. Bu ko'pincha deb ataladi foydalanuvchi yordam. The foydalanuvchi hujjatlari mijozga yetkazib beriladigan umumiy mahsulotning bir qismidir.

Buni hisobga olsak, qanday hujjatlar turlari mavjud?

Turlari tizimning hujjatlar talablarni o'z ichiga oladi hujjat , manba kodi hujjat , sifat tekshiruvi hujjatlar , dasturiy ta'minot arxitekturasi hujjatlar , yechim bo'yicha ko'rsatmalar va ilg'or foydalanuvchilar uchun yordam qo'llanmasi. Turlari foydalanuvchi hujjatlar o'quv qo'llanmalari, foydalanuvchi qo'llanmalari, nashrlar eslatmalari va o'rnatish qo'llanmalarini o'z ichiga oladi.

Dasturiy ta'minot hujjatlariga nimalar kiritilishi kerak?

Hujjatingizga nimani kiritish kerak

  1. dasturiy ta'minotingiz nima qilishini va qanday muammoni hal qilishini tushuntirish.
  2. Sizning kodingiz odatda qanday holatlarda ishlatilishini ko'rsatadigan misol.
  3. kod va xatolar kuzatuvchisiga havolalar.
  4. Tez-tez so'raladigan savollar va yordam so'rash usullari.
  5. dasturiy ta'minotni o'rnatish bo'yicha ko'rsatmalar.

Tavsiya: