Ixtirochi, dasturchi yoki ratsionalizator qanchalik zukko bo'lmasin, ba'zida uning ijodidan maqsadiga muvofiq foydalanib bo'lmaydi. Buning sababi noto'g'ri tuzilgan qo'llanma yoki uning to'liq yo'qligi. Ammo hatto ixtirochi ixtirochilar ham ba'zan shunday ko'rsatmalarni yozadilar, tor mutaxassislardan tashqari, bu hujjatlarni hech kim o'qiy olmaydi. Xo'sh, bunday kerakli hujjatni qanday qilib to'g'ri rasmiylashtirasiz?
Bu zarur
- - qo'llanma yozilayotgan qurilma yoki dasturiy mahsulot haqida yuz foiz bilimga ega bo'lish;
- - tilshunoslik sohasidagi bilimlar;
- - yozish qobiliyatlari.
Ko'rsatmalar
1-qadam
Foydalanuvchilar uchun qo'llanma yoki boshqacha qilib aytganda, foydalanish bo'yicha qo'llanma - bu ma'lum bir tizimdan foydalanuvchilarga yordam berish uchun mo'ljallangan hujjat. Foydalanuvchilar uchun qo'llanmani tuzish uchun siz tavsiflangan tizimni yuz foiz bilishingiz kerak, ammo unga johil talabaning ko'zi bilan qarang. Aytaylik, hali analoglari bo'lmagan dasturiy ta'minot uchun foydalanuvchi qo'llanmasi yozilgan. Ushbu dasturdan birinchi marta foydalanayotganingizni tasavvur qiling. Qaerdan boshlaysiz? Bilish uchun birinchi narsa nima? Ushbu bilimlarni ahamiyatlilik toifalariga ajratib oling.
2-qadam
Yaratilishingizga oid barcha ma'lumotlarni guruhlarga bo'lish orqali siz foydalanuvchi qo'llanmasini yozish rejasini tuzdingiz. Dasturingizdagi ishni noldan ta'riflashni boshlang, so'ngra eng qiyin tafsilotlarni qoldiring, masalan, dasturlarni qayta dasturlash yoki muhim xatolar bilan ishlash. Ushbu bosqichda siz foydalanuvchi qo'llanmasining tarkibiga tayyor bo'lishingiz kerak - ushbu hujjatning kerakli qismlaridan biri.
3-qadam
Agar siz yaratayotgan qo'llanma yirik kompaniyada foydalanish uchun mo'ljallangan bo'lsa, unda siz u erda qabul qilingan korporativ standartlarga e'tibor berishingiz kerak. Masalan, ko'plab rus kompaniyalarida foydalanuvchi qo'llanmalari illyustratsion yordamsiz qabul qilinmaydi, boshqacha qilib aytganda, yozilgan narsalarni tushuntirib beradigan rasmlar. Tarkibdan tashqari foydalanuvchi qo'llanmasida boshqa majburiy qismlar ham bo'lishi kerak: - izoh, ya'ni qo'llanmaning umumiy maqsadlari va tavsiflangan mahsulotni tushuntirish; - foydalanuvchi qo'llanmasiga oid hujjatlarni va qanday ishlashini tavsiflovchi kirish qo'llanmani ishlatish; - mahsulotni ishlatilishining turli bosqichlarida, masalan, birinchi qadamlar, ta'mirlash yoki texnik xizmat ko'rsatishda foydalanishni tushuntirib beradigan qismlar; - tez-tez so'raladigan savollar va ularga javoblarning bo'limi; - lug'at yoki mavzu ko'rsatkichi.
4-qadam
Odatda texnik yozuvchi foydalanuvchi qo'llanmasini yaratishda ishtirok etadi - bu tilda ham, ta'riflanayotgan mahsulotda ham barcha kerakli bilimlarga ega bo'lgan shaxs. Ta'limisiz texnik yozuvchi sifatida, bir nechta qoidalarni yodda tutish kerak. Birinchidan, siz oddiy foydalanuvchi uchun tushunarsiz bo'lgan maxsus shartlarni suiiste'mol qilmasligingiz kerak. Ikkinchidan, ishlatilgan har bir atama batafsil va tushuntirilishi kerak. Uchinchidan, iloji boricha aniq va aniq yozishingiz kerak. Va nihoyat, texnik muallif o'z matnidagi kamchiliklarni ko'rish uchun o'z matniga oddiy foydalanuvchi nigohi bilan qarashga qodir bo'lishi kerak.
5-qadam
Foydalanuvchi qo'llanmasining tugallangan matnini tavsiflangan mahsulot bilan hech qanday aloqasi bo'lmagan odamga taklif qilish orqali amalda sinab ko'rish yaxshidir. Birgalikdagi sa'y-harakatlar bilan hujjatning barcha kamchiliklari va tuzoqlarini yo'q qilish mumkin.
