Bajardi: Nurmatov B

Tizim hujjatlari nima

Tizim hujjatlari bu o'rnatilgan yechim haqidagi ma'lumot bo'lib, kelgusida texnik xizmat ko'rsatish yoki yangilash bo'yicha harakatlar uchun ma'lumotnoma vazifasini bajaradi. U tizimga o'zgartirishlar kiritilganda emas, balki tizim funksionalligi asosida tashkil etilgan bo'lib, yechimni qo'llab-quvvatlovchi odamlarga kerakli ma'lumotlarni tezda topishni osonlashtiradi.

Yechimning o'zi (va unga qarshi yozilgan testlar) juda ko'p ma'lumot berishi mumkin bo'lsa-da, har doim qo'shimcha ma'lumot manbalariga, ayniqsa ko'zga ko'rinmaydigan jihatlarga ehtiyoj bo'ladi. Ushbu ma'lumot turli shakllarda bo'lishi mumkin, lekin men odatda quyidagilarning kombinatsiyasiga ega bo'lishni yaxshi ko'raman:

Lug'at: tizim ishlayotgan sohada tez-tez ishlatiladigan atamalarning ta'riflari

Biznes qoidalari katalogi: qoidalarning tavsifi, lekin bu qoidalar qanday bajarilishini ko'rsatmasdan (bu ma'lumot odatda boshqa artefaktlardan birida qayd etilgan yoki testlar bilan ifodalangan)
Metadata: tizim to'playdigan, saqlaydigan va taqdim etadigan ma'lumotlar haqidagi ma'lumotlar
Jarayon oqimlari: tizim qo'llab-quvvatlaydigan biznes-jarayonlarning tavsifi
Foydalanuvchi interfeyslari: sahna ortidagi operatsiyalarning tavsifi yoki foydalanuvchi interfeysi bilan bog'liq biznes qoidalarining bajarilishi.
Ruxsatlar: tizimda qaysi rollar qaysi funksiyalarni bajarishi mumkinligi tavsifi
Misol
Konferentsiyani yuborish tizimi uchun biz manbalarni boshqarish uchun GitHub-dan foydalanamiz va biz kiritayotgan o'zgarishlar davomida bog'lanishimiz kerak bo'lgan har qanday hujjatlar uchun. Har bir o'zgarish muammo sifatida ko'rsatilgan va har qanday o'ziga xosliklar biz taxminlarni aniqlashtirish uchun foydalanadigan sharhlarning orqa va orqa qismida tasvirlangan.
Shuningdek, biz har bir element uchun yozgan misollarni saqlaymiz. Ushbu misollar tizim xususiyatlariga asoslangan holda tuzilgan va biz yuborish tizimi to'g'ri ishlamayotgan holatni tekshirayotganimizda mening birinchi murojaatim bo'lib xizmat qiladi. O'ndan to'qqiz marta, nuqson biz ishlab chiqish ishimiz davomida hisobga olmagan stsenariy bo'lib tugaydi, bu misolning yo'qligi bilan tasdiqlanadi.
Misollar va yomon xotiramni to'ldirish uchun men ruxsatlarni aks ettiruvchi elektron jadvallarni, shuningdek, ma'lum sharoitlarda chiqadigan maxsus bildirishnomalar haqida eslatmalarni yaratdim. Bu GitHub yoki tizimning o'zidan boshqa ma'lumot nuqtasida saqlash uchun foydali bo'lgan asosiy ma'lumotlar bo'laklari bo'ladi.