Ойлоп табуучу, программист же рационализатор канчалык тапкыч болбосун, кээде анын жараткан нерселери өз максатына ылайык колдонулбай калат. Мунун себеби туура эмес түзүлгөн колдонмо колдонмо же анын толук жоктугу. Бирок тапкыч ойлоп табуучулар да кээде мындай көрсөтмөлөрдү жазышат, тар адистерден тышкары, бул кагаздарды эч ким окуй албайт. Ошентип, мындай зарыл документти кантип туура тариздөө керек?
Ал зарыл
- - колдонмо жазылып жаткан шайман же программалык продукт жөнүндө жүз пайыз билим;
- - тил илими жаатындагы билимдер;
- - жазуу көндүмдөрү.
Нускамалар
1 кадам
Колдонуучунун колдонмосу же башкача айтканда, колдонмонун колдонуучусу - колдонуучуларга белгилүү бир тутумду колдонууга жардам көрсөтүү максатында иштелип чыккан документ. Колдонуучунун колдонмосун түзүү үчүн, сүрөттөлгөн тутумду жүз пайыз билишиңиз керек, бирок аны сабатсыз студенттин көзү менен карап көрүңүз. Азырынча окшоштору жок программалык камсыздоо үчүн колдонуучу колдонмо жазылган деп коёлу. Бул программаны биринчи жолу колдонуп жатканыңызды элестетип көрүңүз. Эмнеден баштайсыз? Эң биринчи эмнени билүү керек? Бул билимдерди маанилүүлүк категорияларына бөлүңүз.
2-кадам
Сиздин жаратууңуз боюнча бардык маалыматты топторго бөлүштүрүү менен, колдонуучунун колдонмосун жазуунун планын түздүңүз. Программаңыздагы ишти башынан баштап сүрөттөп баштаңыз, эң акыркы деталдарын калтырып, мисалы, кайра программалоо өзгөчөлүктөрү же олуттуу каталар менен иштөө. Ушул этапта колдонуучунун нускамасынын мазмуну даяр болушу керек - бул документтин талап кылынган бөлүктөрүнүн бири.
3-кадам
Эгерде сиз түзүп жаткан колдонмо ири компанияда колдонууга арналган болсо, анда ал жерде кабыл алынган корпоративдик стандарттарга көңүл бурушуңуз керек. Мисалы, көптөгөн россиялык компанияларда колдонуучунун колдонмолору иллюстративдик колдоосу жок кабыл алынбайт, башкача айтканда, жазылганды түшүндүргөн сүрөттөр. Мазмундан тышкары, колдонуучунун колдонмосунда дагы башка милдеттүү бөлүктөр камтылышы керек: - аннотация, башкача айтканда, колдонмонун жана сүрөттөлгөн өнүмдүн жалпы максаттарынын түшүндүрмөсү; - колдонмо колдонмосуна байланыштуу документтерди жана кандайча сүрөттөлгөн кириш сөз колдонмону колдонуу; - өнүмдү пайдалануунун ар кандай баскычтарында колдонууну түшүндүрүүчү бөлүмдөр, мисалы, биринчи кадамдар, оңдоо же техникалык тейлөө; - көп берилүүчү суроолор жана аларга жооптор бөлүмү; - глоссарий же предметтик индекс.
4-кадам
Адатта, техникалык жазуучу колдонуучунун колдонмосун түзүүгө катышат - тилде жана сүрөттөлгөн өнүмдө бардык керектүү билимге ээ адам. Билимсиз техникалык жазуучу катары бир нече эрежелерди эске алуу керек. Биринчиден, жөнөкөй колдонуучуга түшүнүксүз болгон атайын терминдерди кыянаттык менен пайдаланбаңыз. Экинчиден, колдонулган ар бир термин толук жана түшүндүрүлүп берилиши керек. Үчүнчүдөн, мүмкүн болушунча так жана так жазуу керек. Акыр-аягы, техникалык жазуучу өзүнүн текстиндеги кемчиликтерди көрүү үчүн жөнөкөй колдонуучунун көзү менен өз текстин карай билиши керек.
5-кадам
Колдонуучунун колдонмосунун даяр текстин сүрөттөлгөн өнүм менен эч кандай байланышы жок адамга сунуштоо менен, аны сынап көргөн жакшы. Биргелешкен аракеттер менен документтин бардык кемчиликтерин жана кемчиликтерин жоюуга болот.
