Umumiy ma'lumot

Umumiy ma’lumot bo’limi foydalanuvchilaringiz loyihangiz haqida ma’lumot oladigan joydir. Hujjat to’plamingizning hajmiga qarab, siz alohida umumiy ma’lumot sahifasiga ega bo’lishingiz mumkin (xuddi shu kabi) yoki umumiy ma’lumot mazmunini Hujjatlar asosiy sahifasiga joylashtira olasiz (Docsy User Guide kabi).

Ushbu sahifada foydalanuvchilaringiz uchun quyidagi savollarga javob berishga harakat qiling:

Bu nima?

Loyihangizni taqdim eting, shu jumladan u nima qilishi yoki sizga nima qilish imkonini berishi, nima uchun undan foydalanishingiz va uning asosiy maqsadi (va uni qanday erishishi) haqida. Bu sizning README tavsifingizga o’xshash bo’lishi kerak, garchi agar xohlasangiz, bu yerda biroz batafsil ma’lumot berishingiz mumkin.

Nima uchun men buni xohlayman?

Foydalanuvchilaringizga loyihangiz ularga yordam berishini bilishlariga yordam bering. Foydali ma’lumotlar quyidagilarni o’z ichiga olishi mumkin:

• U nima uchun yaxshi?: Loyihangiz qanday turdagi muammolarni hal qiladi? Undan foydalanishning qanday afzalliklari bor?

• U nima uchun yaxshi emas?: Masalan, loyihangiz uchun intuitiv ravishda mos bo’lishi mumkin bo’lgan, lekin qandaydir sabablarga ko’ra mos kelmaydigan vaziyatlarni ko’rsating. Shuningdek, ma’lum cheklovlar, masshtablash muammolari yoki foydalanuvchilaringizga loyiha ular uchun emas ekanligini bildirishi mumkin bo’lgan boshqa narsalarni ham eslatib o’ting.

• U hali nima uchun yaxshi emas?: Tez orada paydo bo’ladigan foydali xususiyatlarni ta’kidlang.

Keyingi qadamim qayerga bo’lishi kerak?

Umumiy ma’lumotdan keyin foydalanuvchilaringizga keyingi qadamlarni bering. Masalan:

• Boshlash: $project bilan boshlang
• Misollar: Ba’zi misol kodlarni ko’rib chiqing!