Technical Documentation Copy and Paste Kit

Tavsif

Yo'q, bu to'plam siz uchun keyingi foydalanuvchi qo'llanmasini yoki keyingi onlayn yordam tizimini yozmaydi. Biroq, ushbu to'plam sizga texnik hujjatlarni kamroq kuch sarflab yozishga yordam beradi va foydalanuvchilarga qulay, yuqori sifatli hujjatlarni ishlab chiqarishga yordam beradi.

To'plam sizga matn muharriri, mualliflik yordami vositasi yoki kontentni boshqarish tizimi taqdim etmaydigan narsalarni taqdim etadi: yuqori sifatli foydalanuvchi yordamini yaratish bo'yicha nou-xau va ko'rsatmalar.

Biroq, texnik yozish bo'yicha ko'plab darsliklardan farqli o'laroq, to'plam uzoq nazariy ishlanmalarni bermaydi. Siz osongina eslab qolishingiz va o'zingizning ishingizga moslasha oladigan amaliy tavsiyalar va misollar beradi.

To'plam quyidagilarni o'z ichiga oladi:

* hujjatlaringizning vizual dizayni (tartibi).

* hujjatlaringizning tuzilishi

* har bir foydalanuvchi tushunadigan oddiy ko'rsatmalarni qanday yozish kerak

Dizayn tavsiyalarini amalga oshirish uchun dizayner bo‘lish shart emas, yozish qoidalarini tushunish uchun esa tilshunos bo‘lish shart emas. Barcha tavsiyalar diqqatga sazovor misollar bilan birga keladi.

To'plam oddiy, sodda ingliz tilida yozilgan bo'lib, siz ingliz tilini ikkinchi til sifatida bilsangiz ham oson tushuna olasiz. Deyarli barcha qoidalar universaldir, shuning uchun siz ingliz tilidan boshqa tillarda yozsangiz, to'plamdan ham foydalanishingiz mumkin.

To'plamning Plus nashrida siz va sizning jamoangiz o'zingizning kompaniyangizga xos konventsiya va qoidalarni qo'shishingiz mumkin. Professional, ammo moslashtirilgan interaktiv yozish uslubi bo'yicha qo'llanmani olish hech qachon oson bo'lmagan. Qoidalarni kim o'zgartirishi mumkinligini siz erkin boshqarishingiz mumkin: faqat siz, faqat tanlangan jamoa a'zolari yoki hamma.