Technical Documentation Copy and Paste Kit

Сипаттама

Жоқ, бұл жинақ сіз үшін келесі пайдаланушы нұсқаулығын немесе келесі онлайн анықтама жүйесін жазбайды. Дегенмен, бұл жинақ техникалық құжаттаманы аз күш жұмсап жазуға көмектеседі және ол сізге ыңғайлы, жоғары сапалы құжаттарды жасауға көмектеседі.

Жинақ сізге мәтіндік редактор, анықтамалық авторлық құрал немесе мазмұнды басқару жүйесі қамтамасыз етпейтін нәрселерді ұсынады: жоғары сапалы пайдаланушы көмегін жасау үшін ноу-хау және нұсқаулық.

Дегенмен, техникалық жазу бойынша көптеген оқулықтардан айырмашылығы, жинақ ұзақ теориялық өңдеулерді бермейді. Ол оңай есте сақтауға және өз жұмысыңызға бейімделуге болатын практикалық ұсыныстар мен мысалдар береді.

Жинақ мыналарды қамтиды:

* құжаттарыңыздың визуалды дизайны (орналасуы).

* құжаттарыңыздың құрылымы

* әрбір пайдаланушы түсінетін қарапайым нұсқауларды қалай жазу керек

Дизайн бойынша ұсыныстарды орындау үшін дизайнер болудың қажеті жоқ және жазу ережелерін түсіну үшін лингвист болудың қажеті жоқ. Барлық ұсыныстар қызықты мысалдармен бірге келеді.

Жинақ қарапайым, қарапайым ағылшын тілінде жазылған, оны сіз ағылшын тілін екінші тіл ретінде сөйлесеңіз де оңай түсінуге болады. Барлық дерлік ережелер әмбебап болып табылады, сондықтан сіз ағылшын тілінен басқа тілдерде жазсаңыз, жинақты да пайдалана аласыз.

Жинақтың Plus шығарылымында сіз және сіздің командаңыз өзіңіздің компанияңызға тән конвенциялар мен ережелерді қоса аласыз. Кәсіби, бірақ теңшелетін интерактивті жазу стилі нұсқаулығын алу ешқашан оңай болған емес. Ережелерді кім өңдей алатынын басқара аласыз: тек сіз, тек таңдалған топ мүшелері немесе барлығы.