Техническото писане съобщава на читателите техническа информация за умение или продукт. Обикновено се използва в техническите и професионални области. Като технически писател вие често пишете документи като ръководства за потребителя, документация за интерфейс за програмиране на приложения (API) и ръководства за ремонт и продукти.
Подобно на други ниши за писане, техническото писане има насоки, специфични за нишата. Следването на тези указания ще ви помогне да пишете добре структурирани документи и ще оптимизирате начина, по който читателите разбират работата ви. Ето някои правила, които трябва да следвате, за да станете добър технически писател.
1. Определете своята аудитория
Анализът на аудиторията е незаменим фактор в добрия технически документ. Познаването на вашата аудитория ви помага да определите вида информация, за която да пишете, как трябва да я структурирате и техническата част на вашия език. Има четири основни аудитории за техническо писане: ръководители, експерти, техници и неспециалисти.
Ръководителите са лица, които финансират продукта и вземат политически, административни и икономически решения, които го управляват. Техниците са хората, които изграждат, експлоатират и ремонтират тези продукти. Експертите проектират, тестват и знаят всичко за продукта, докато неспециалистите са крайните потребители на продуктите. Трябва да имате предвид аудиторията си, за да определите най-добрия тон и стил на писане, които да използвате.
2. Идентифицирайте нуждите на аудиторията си
Освен познаването и определянето на вашата аудитория, от решаващо значение е да разбирате нейните цели, интереси и нужди. Завършването на анализа на вашата аудитория е ключово при подготовката на документа, тъй като е по-малко вероятно да пишете без проблеми и да познавате добре нуждите на вашата аудитория.
За да извършите добре закръглен анализ на аудиторията, трябва да имате предвид произхода на вашата аудитория, съществуващите познания за нея продукта, опит, нужди, интереси, демографски характеристики, култура и комуникационни предпочитания и цели. Тази информация ще ви помогне да представите идеите си най-ефективно и ефикасно.
3. Познавайте границата на знанията на вашата публика
Като техника за анализ на аудиторията можете да използвате анкети и въпросници, за да разберете границата на знанията на вашата аудитория. Можете също така да получите популярни мнения и стереотипи, личен опит, мозъчна атака и обратна връзка от публиката от маркетинговия отдел.
Ако използвате правилно изброените по-горе инструменти, ще знаете доколко вашата целева аудитория разбира информацията, която възнамерявате да предадете. Тази информация до голяма степен ще определи структурата, ограниченията и обхвата на вашия документ, като ви дава усещане за посока.
4. Поддържайте езика си прост
Техническото писане трябва да представя твърде сложна тема. Той прави това с помощта на просто ръководство за стил на писане. Трябва да сте сигурни, че обикновеният читател може лесно да разбере написаното от вас.
Все пак трябва да имате предвид, че разбирането на вашата аудитория също е от ключово значение за избрания от вас езиков стил. Например професионален жаргон в документ за интерфейси за приложно програмиране (API) може да е подходящ за техници, но не и за крайни потребители. Следователно трябва да използвате лесен за разбиране език, за да подпомогнете разбирането на публиката. Може също да искате да научите как да използвате инструмент като Microsoft Editor за да проверите работата си и да се уверите, че написаното е на място.
5. Използвайте очертания
Очертанията дават на вашите читатели представа какво да очакват в документа. Документ без схема завладява читателите, тъй като ги принуждава да прочетат целия текст, когато се интересуват само от придобиване на конкретни знания.
Като технически писател очертаването на вашия документ също ви дава усещане за посока, когато пишете. Той ви държи на път и гарантира, че няма да пропуснете или подцените съответните точки. Освен това подобрява структурата на вашия документ и служи като обратна връзка за това, което възнамерявате да покриете.
6. Използвайте графики, където е необходимо
Вниманието на повечето читатели е естествено привлечено от графики в сравнение с текст. В техническите документи подходящите графики могат да подобрят разбирането на текста от читателите, като представят информацията ясно и категорично.
Въпреки това, като технически писател, трябва да внимавате да не използвате графики за декориране на документи. Таблици, графики, диаграми, снимки и илюстрации са често използвани графики и те могат да подобрят цялостната структура на документа и да привлекат вниманието на читателите. Въпреки това, ако не сте запознати с Google Документи, ето го как да създавате и редактирате таблици в Google Документи.
7. Ангажирайте читателите си
Въпреки че може да се опитвате да предадете техническа информация на вашите читатели, важно е също така да ги ангажирате. Всеки технически документ е ориентиран към читателя и трябва да бъде написан според вкуса на читателя, а не на писателя. Интелектуалното любопитство на вашия читател трябва да бъде задоволено, за да бъде вашият документ полезен.
Можете активно да ангажирате читателя си, като пишете, за да изразите, а не да впечатлите, и да преминете направо към въпроса. Избягвайте съкращения и жаргон, използвайте много бяло пространство, за да подобрите визуалното представяне и използвайте заглавия, за да насочвате читателя си.
8. Не препращайте към чувствителна към времето информация
Избягването на препратки към чувствителна към времето информация, особено към съпоставим период, винаги е за предпочитане. По-безопасно и по-разумно е да използвате анализ, който е издържал теста на времето, което го прави вечно зелен и винаги подходящ за тези, които ще четат вашия документ в бъдеще.
Трябва също така да имате предвид, че добавянето на конкретни години, като „2019“, за да подчертаете вашата гледна точка, може да намали полезността на вашия документ с течение на времето, освен в определени случаи. Можете да предотвратите това, като използвате по-широка времева рамка като „През последните седем години“, като по този начин придадете на работата си ниво на достоверност.
9. Използвайте подходящи примери
Когато пишете технически документ, използвайте живи екземпляри, за да подчертаете точките си. Тъй като аудиторията ви чете написаното от вас, за да придобие умение, да реши проблем или да научи някои насоки, вие трябва да й предоставите практични и сравними примери.
Тези примери подобряват четливостта на вашата работа и съобщават сложна информация на вашия читател, предоставяйки контекст на продуктите и процесите. По този начин е по-вероятно те да използват продуктите умишлено и безопасно.
10. Получете преглед от трета страна преди публикуване
Един технически документ трябва винаги да преминава през процес на сътрудничество, който включва автора и рецензента. Преглед от трета страна помага за генерирането на фокусиран върху аудиторията, без грешки и въздействащ документ.
Като оригинален автор на документа може да сте написали много чернови, преди да създадете окончателния документ. Независимо от това, колкото и добър да изглежда вашият документ, не разчитайте само на разума си.
Станете професионален технически писател днес
Разбирането на основните правила, ръководещи техническото писане, ще ви направи по-компетентни и много търсени. Много организации знаят колко е важно техните продукти или услуги да бъдат добре продавани на крайните потребители и да им помогнете да постигнат това е вашата цел като технически писател.
