Всё для технического документирования
+7 (495) 001-40-42
Разработка технической документации
Курсы для технических писателей
Программное обеспечение

Как стать эффективным техническим писателем

26.05.2014

26.05.14Вопрос, которым задаются все начинающие писатели, – как работать наиболее эффективно. Дэннис Ридли предлагает несколько советов, возможно, они покажутся банальными и очевидными, но, как показывает практика, оказываются основополагающими в успешной карьере. Итак, памятка для начинающих (и не очень) писателей.


Практика технического писательства сильно отличается от художественного с точки зрения цели и стиля. Последним обычно занимаются поэты и прозаики, они любят играть со словами и ломать нормы традиционного письма для внесения стиля и красоты в свои произведения. Использование расплывчатых образов допускается в художественном писательстве; однако, для технических писателей недопустимо выражать в работе чересчур много творчества. Техническое писательство характеризуется как формальный путь передачи ясного и чёткого послания читателям. Оно строго утилитарно, с единственной целью – сообщить, а не позабавить или развлечь; обычный стиль для новостей, редакционных колонок и деловых статей.

Ниже приведены практические советы, которые помогут вам улучшить ваш стиль.

Будьте ясным и кратким

Главное правило технического стиля письма заключается в использовании ясных и простых слов и лаконичных предложений. «Никогда не используйте длинные слова, если можно сказать короткими; короткие предложения придадут вашему письму ясности, а технический стиль требует писать так лаконично, насколько это вообще возможно», – писал Эвелин Уилсон на официальном сайте Ирландских Писателей.

Определите цели письма

Кэйт Джонсон с Freelancefolder.comсчитает, что у мудрого технического писателя должна сформироваться чёткая цель перед написанием статьи. Неудачи в определении цели могут привести к непонятным или противоречивым результатам. Многим техническим писателям не удаётся передать чёткое послание при описании продукта из-за своей перегруженности техническими и функциональными моментами. Их цель здесь заключается в упрощении жаргонов, чтобы обычные люди могли понять информацию.

Подавайте точную информацию

В беллетристике можно безгранично сочинять факты, даже если эти факты являются расплывчатыми, закрученными и неточными. Техническое писательство – сплошь точность. «Перед тем как публиковать записи дважды, а то и трижды проверьте факты, которые вы там указали», – пишет Аниндита Басу с writing-technical.blogspot.com. Вы должны «писать только о том, что вы поняли и проверили».

Этой же точки зрения придерживаются контент-специалисты с WiseMarketing. На своём сайте для копирайтеров они упомянули, что всегда начинают с исследования, перед тем, как сесть за клавиатуру.

«Хотя мы иногда и пренебрегаем исследованием из-за необходимости мгновенных результатов, мы считаем, что надлежащее исследование станет основой хорошего контента», – указывает сайт. Это также означает правильное понимание целевого рынка контента и выяснение нового о продукте или услуге, о которых вы пишете.

Будьте постоянны

Когда вы описываете действия или шаги, нужно придерживаться постоянства в словах и терминах. Например, если на первой странице документа был использован термин «рефрижератор», используйте его повсюду. Использование слов «холодильник» или «морозильник» – не лучшее решение. Но для онлайн-статей не рекомендуется повторение ключевых слов. Google пометит вашу статью как спам, если в ней очень часто повторяется одно и то же ключевое слово. Для описания одного предмета или явления можно использовать максимум три термина (например, сотовый телефон, мобильный телефон, смартфон).

Источник: How To Become An Effective Technical Writer

Тэги: , , ,

< Вернуться к списку публикаций

Облако тегов