Как написать технический текст?
Эта статья-рассуждение, в которой я постараюсь рассказать, как я пишу технические тексты, покажу с какими тонкостями и нюансами мне приходилось сталкиваться при работе над узкоспециализированными статьями для коммерческих и контентных веб-сайтов. Приведу некоторые особенности и рекомендации по написанию технических текстов.
Эта статья — мой начальный опыт работы в копирайтинге и предваряет новую статью по особенностям и структуре технических текстов. Читайте.
Любой продукт имеет свою техническую составляющую. Не будем говорить о строительных материалах, инструментах, технических процессах и прочих подобных предметах, а возьмем, к примеру, духи, они имеют свою ольфакторную пирамиду с определенными составляющими, которые могут быть интересны пользователю. При чтении описания читатель получит не только красочное описание духов, но и узнает, чем обусловлен сказочный аромат. Правильная подача технической информации, как для веб-сайтов, так и для продающих компаний стоит, отнюдь, не на последнем месте.
Важно : для написания статей, касающихся технических описаний, изучать инструкции, документацию, руководства, а в некоторых случаях, ГОСТы, в них наиболее четко прописаны технические условия, характерные для услуги или изделия.
Но как для веб-сайтов, так и для продающих компаний текст должен быть написан для людей, информация должна быть подана живым языком, возможно, в некоторых случаях, для большей наглядности даже с употреблением некоторых элементов разговорной речи. Написание технических текстов — очень сложная задача, которую может выполнить далеко не каждый, даже виртуозно владеющий слогом копирайтер. Зачастую, только одного умения написать техническую статью бывает недостаточно, требуется знание технического процесса, профессиональные навыки, нюансы производства, бывает нужно привязать к статье собственный опыт, привести практические примеры.
Для написания статей придерживаются необходимых рекомендованных правил размещения и соблюдения структуры логического построения текста.
Техническая статья категорически не допускает неточности, в то же время, если вы используете понятную для специалиста инструкцию, должна быть для обычного пользователя, переведена на человеческий, доступный для понимания, язык. Автор должен изложить суть статьи доступными словами, которые могут быть поняты рядовым посетителем сайта и в то же время, в ней должна быть исключена двоякость понимания. Нельзя при этом забывать об уникальности текста.
Написание SEO-оптимизированных технических текстов требует от копирайтера огромной ответственности. Ошибки должны быть полностью исключены, информация должна быть подана точно и правильно. Иногда в этом деле помогает набор проверенных инструментов.
Рекомендации для написания технических текстов
Несмотря на то, что подача технического материала осуществляется доступным понятным языком, в целом стиль должен быть официально-деловым. Это подразумевает стандартное расположение материала. Желательно исключить из текста эмоциональные речевые выражения, предпочтительно использование профессиональных терминов, с пояснениями. Слова должны подаваться прямым порядком, необходимо использовать отглагольные существительные.
По мере написания статьи автор должен анализировать написанное, чтобы исключить двоякое понимание или домысливание текста читателем.
На основании изучения опыта других копирайтеров постарался вывести для себя алгоритм написания статей и поиска информации. Более подробно в этой статье.
Структура технического текста
Прежде всего, структура подразумевает логическое расположение материала. В этом случае читатель статьи с легкостью найдет интересующую его информацию. В техническом описании последовательно указывается процесс создания изделия, материал изготовления, его свойства, изменения и т. д. Лучше всего, если описания, например, технических процессов будут приведены к единому стандарту.
Характер подачи материала должен быть выполнен в адекватной манере изложения. Желательно статью писать в повествовательной форме, от третьего лица, доброжелательным языком. Обращения к читателю необходимо полностью исключить.
Прежде всего, текст должен носить сугубо информативный характер без эмоциональных оценок, без метафор и каких-либо олицетворений.
Целевая аудитория web-сайта
Текст должен быть ориентирован на определенную целевую аудиторию сайта. Технические тексты пишутся в зависимости от категории пользователей. Возьмем, к примеру, интернет-магазин, занимающийся распространением светотехнической продукции, допустим люстр. В этом случае, желательно чтобы информация, например, о светодиодных лампах, была понятна женщинам, делающим выбор люстры или светильника для своего дома, ведь именно они являются главными посетителями такого сайта. Однако, даже красивое продающее описание для сайта интернет-магазина должно нести техническую информацию. материал, положительные качества цвета плафона, тип лампочки, предназначение и область применения, показатели освещенности. Это важно, любая женщина оценит полезность материала и сделает выбор.
Например, тот же сайт по светотехнике, но уже описание лампочек для автомобильных фар. Это информация должна нести больше конкретики, преимущества и недостатки, область применения. В каких именно фонарях используются лампы: для габаритов, для дальнего света, для салона и т. д.
Терминология
Техническим текстам свойственна одна и, пожалуй, главная особенность — использование специальных терминов. В тексте необходимо дать точную формулировку и правильно объяснить термин.
Профессиональная терминология должна выдерживаться определенного, в начале текста введенного порядка, не следует заменять термин синонимом или пояснительным словосочетанием, заставляя читателя задумываться над словом, вводя его в заблуждение. Зачастую, для перевода технического термина приходится пользоваться специальным словарем.
Чтобы написать технические тексты копирайтер иногда досконально изучает дополнительный материал, чтобы только понять один определенный, специальный термин в статье, касающийся, казалось бы, несущественного, но, тем не менее, важного элемента.
Оформление текста
Графическое оформление должно улучшить восприятие текстового документа. Чертежи, рисунки, таблицы, графики обязательно должны присутствовать в тексте. Сплошной текст, каким прекрасным бы он не был, воспринимается читателем очень тяжело и способен удержать посетителя сайта только в случае крайней необходимости и исключительности подаваемого материала. Если на соседнем сайте найдется похожий контент, разбавленный рисунком, посетитель уйдет с этого сайта туда, ведь там текст воспринимается легче, там есть за что зацепиться глазом, там рисунок наглядно поясняет текстовый документ.
Это далеко не полный список рекомендаций для написания технических статей для веб-сайтов, но выполнение хотя бы части из них способно существенно повысить качество технического контента. Использование строгого сухого стиля или разбавление текста живыми оборотами, примерами или другими особенностями зависит от технического задания, предоставленного заказчиком и от общего характера сайта, но в любом случае только в силах автора сделать текст востребованным как пользователями, так и поисковыми системами.
Пишем статью
Как же написать хорошую статью по технической тематике?
Надо ли быть гением, чтобы написать грамотную техническую статью? Могут ли лирики правильно писать про физику? Может ли физик доступно объяснить про дифракцию и интерференцию в свете корпускулярно-волнового дуализма? В этой статье не будет ответов на эти вопросы. В тексте этой публикации приведены основные (но далеко не все!) рекомендации, которых следует придерживаться при написании технических статей.
Не существует единого общепринятого алгоритма или свода правил написания статей, но есть ряд общих правил, которых стоит придерживаться при работе над публикациями любой тематики.
В первую очередь, необходимо разбираться в предмете и чётко понимать, на какую целевую аудиторию должен быть ориентирован текст. Во-вторых, следует сформулировать тему и выразить её в краткой и ёмкой форме в заголовке. Далее – писать грамотно, в рамках выбранной темы, соблюдая стиль повествования.
Чтобы полностью раскрыть тему и не забыть о мелких нюансах, которые могут стать решающими, следует составить план публикации. Материал необходимо изложить последовательно, в логичном порядке.
Основной текст статьи следует излагать краткими предложениями. Удачно подобранные методы форматирования (списки, абзацы и т.п.) создают зрительные ориентиры, помогающие читателю быстро просматривать информацию и находить интересующие его сведения. Однако, чрезмерное использование элементов форматирования (маркированные и нумерованные списки, выделение слов) снижают качество подачи материала.
В зависимости от цели публикации формируется окончание статьи. Если в заголовке или вводной части статьи есть заявление о проведении анализа по теме, то в конце статьи должен присутствовать вывод. Когда публикация не направлена на анализ, а написана для того, чтобы обобщить некоторый материал, поделиться знаниями, в конце повествования должно быть сделано некоторое обобщающее заключение (призыв, предложение, рекомендация).
Особенности написания технических статей
Написание технических статей требует особых умений, навыков и знаний в предметной области. Статья должна быть написана грамотным русским языком – не только с точки зрения орфографии и пунктуации, но также синтаксиса и фразеологии. Красивый технический стиль – отличный способ избежать ситуации, когда читатель начинает задумываться о том, насколько автор компетентен в рассматриваемом вопросе. Давно известна истина: если вы чётко и ясно мыслите, вы чётко и ясно излагаете.
Задачи у текстов могут быть разными: просвещение, продажа услуг или разработка экспертных материалов. При этом следует помнить, что в результате должен получиться текст на техническую тематику, а не какой-то технический документ. Не стоит избегать образного, живого языка: образы облегчают понимание и освоение информации. Однако надо помнить, что в техническом тексте материал должен быть изложен чётко, конкретно и лаконично. Следует избегать техницизмов, профессионализмов, оборотов разговорной речи.
Даже такие устоявшиеся жаргонизмы, как «юзер», «свитч» и тому подобные, неуместны в технической статье. Не стоит использовать сложные термины, особенно, если целевой аудиторией является неподготовленный читатель. Если применения таких терминов избежать не удалось, можно добавить глоссарий с доступным толкованием использованных понятий. Однако объяснять очевидное также не стоит. При ссылке на общеизвестные методы, технологии, алгоритмы не нужно разъяснять их суть, достаточно просто указать, как они применяются.
Итак, в первую очередь необходимо определиться с темой статьи. Тема – это кратко сформулированное содержание предметной области, в рамках которой будет формироваться текст. Тема определяет терминологию, степень детализации рассуждений и определений, ссылки на внешние источники информации, количество и сложность дополнительного материала в виде формул, таблиц, иллюстраций. Также необходимо определиться с целевой аудиторией, уровнем доступности информации, которая будет представлена в раскрытие темы статьи и задачей публикации. Это определит стиль изложения текста.
Далее следует составить план статьи, тезисно определить содержание каждого её раздела. В общем виде он может выглядеть так:
Вступительная часть знакомит читателя с сутью предлагаемого материала. Эта часть публикации должна быть краткой, не более двух-трёх предложений о содержании статьи и её целевой аудитории. Можно сначала написать основной текст статьи и заключение, а потом составить краткую аннотацию написанного и вынести её во введение.
Основная часть – самый большой и важный раздел статьи. В ней последовательно должна быть раскрыта тема публикации, изложены суждения, которые позволили сделать выводы, выдвинуты предложения и рекомендации. Эта часть текста должна содержать не только фактический материал, но и анализ, критическую оценку фактов. В этой части будет полезно привести схемы, таблицы, графики, формулы, рисунки, фотографии. Таблицы должны быть снабжены заголовками, а графический материал – подрисуночными подписями. На каждый такой элемент в тексте статьи должны быть даны ссылки на него.
При написании текста статей на технические темы следует придерживаться научно-технического стиля изложения и руководствоваться основными рекомендациями по оформлению текстовых документов
ГОСТ 2.105-95 (ЕСКД. Общие требования к текстовым документам). Такой стиль, скорее всего, знаком той аудитории, на которую рассчитан материал, и читателям будет проще ориентироваться в тексте и элементах оформления. Технический текст должен содержать точные формулировки и конкретные понятия. Например, определение «большой» или «маленький» не несёт в себе конкретной информации об объекте. Рекомендуется приводить или конкретные параметры (в данном случае, габаритные размеры) или определённые сравнения, например «размером со стандартный лист бумаги формата А4». Следует использовать стандартизированные единицы физической величины, их наименования и обозначения по ГОСТ 8.417-2002 (ГСИ. Единицы величин).
Не стоит использовать в тексте лишние слова («весь процесс в целом», «в целях» вместо «для») и различные загадочные термины («это явление вызвано определёнными факторами», «в некотором смысле» и т.п.). Аккуратности требует употребление возвратной формы глагола. Использовать её возможно, когда речь идёт о самопроизвольно протекающих процессах: «деталь охлаждается». Если требуется описать технологическую операцию, которой подвергают объект, следует писать «деталь охлаждают».
Заключительная часть статьи должна быть увязана с основным текстом как по смыслу, так и стилистически. В ней тезисно излагают выводы, сделанные на основании изложенного материала. Они должны быть объективными, без авторской интерпретации. Так же можно привести оценку практической значимости результатов проведенных исследований.
После того, как работа над текстом статьи закончена, следует внимательно изучить её на предмет употребления ссылок на источники информации и терминов, требующих уточнения, и оформить соответствующие разделы статьи.
Список использованных источников должен содержать название, фамилию и инициалы автора, адрес, где с его содержанием можно ознакомиться. Помещается он в конце статьи. В качестве заголовка можно использовать такие варианты: «Список литературы», «Список использованных источников», «Литература», «Библиографический список». В начале такого перечня располагают законы, указы, законодательные акты.
Далее – остальные печатные источники. В конце указываются электронные ресурсы. Все элементы списка должны располагаться в алфавитном порядке. Книгу без указания автора включают в соответствии с алфавитом по названию. Книги на иностранном языке указывают после книг на русском. В тексте статьи должны быть оформлены ссылки на список источников информации.
Варианты оформления ссылок:
Глоссарий – словарь специализированных терминов. Составлять его надо также в алфавитном порядке. Определение термина в глоссарии должно состоять из двух частей:
Когда работа над текстом статьи и его оформлением окончена, не забудьте сохранить проделанную работу. Перечитайте написанное и проведите авторское редактирование: удалите лишнее, упростите слишком сложно выраженные мысли, непонятные термины, разверните неточные определения. После этого ещё раз перечитайте своё творение, прислушайтесь к внутреннему голосу – если правка и доработка статьи больше не требуются, направляйте её заказчику. Возможно, у заказчика при ознакомлении с работой возникнет желание что-то изменить, добавить, расширить или конкретизировать. Перед тем как вносить такие правки, оцените, на сколько изменения повлияют на раскрытие темы и смысл изложенного. Не стесняйтесь спорить с заказчиком, аргументировано доказывая свою точку зрения.
Не следует рассматривать рекомендации данной статьи как догму, они призваны помочь сориентироваться и начать работу с учётом опыта и наработок других авторов. Ниже приведена примерная последовательность действий при написании технической статьи:
Искусство написания технических текстов или структура статьи как уникальный инструмент для чтения
Ого! Вот это зачихнул – искусство! Потом подумал, на самом деле технический копирайтер выполняет работу вдвойне более сложную, чем обычный автор? Давайте порассуждаем, это ведь личный сайт, а не инструкция и не учебное пособие как писать технические тексты.
Технический текст для коммерческого сайта обладает только ему присущими особенностями. Нужно чтобы и читать было интересно, и смысловое наполнение несло пользу, а не пестрило художественными образами или восторгами такими как: качественные детали, надежное оборудование и т.д. Как сделать? Ответ прост – пишите текст для целевой аудитории сайта и соблюдайте логическую структуру.
Больше 20 лет проработал в высоковольтной энергетике, поэтому примеры, которые использую в статье на тему электрики, выполнены мной для коммерческих сайтов связанных с электро- и светотехникой, электрооборудованием.
Тема этой статьи продолжает статью о техническом тексте, самую первую, написанную для этого блога. Хотя, думаю, что все нижеизложенное может с успехом использоваться и для написания обычного информационного текста.
Что подразумевает технический текст для сайта
Постараюсь разобрать, что такое технический текст для веб-сайта, интернет-магазина или компании, предлагающей услуги. В этом случае технический текст несет некоторую рекламную функцию. Однако продающие признаки заключаются не в художественной окраске, а в информативности. Об этом Ильяхов говорит на страницах «Пиши, сокращай», читайте рецензию на книгу.
Текст должен показать и доказать полезность товара. Исключить всякую двусмысленность. Подача информации должна быть настолько полной, что, прочитав ее, читатель-потенциальный клиент принял решение приобрести изделие или заказать услугу. В этом заключается клиентоориентированность сайта.
Технические понятия обязательны, но должны быть поданы простым и понятным языком. Руководствуются целевой аудиторией, например, вряд ли описание УКРМ (устройство компенсации реактивной мощности) будет интересно барышне, которая ищет китайский прибор, предназначенный как бы экономить электричество. Хотя и в том и другом случае за основу взята конденсаторная батарея. Вся информация должна быть полностью понятна ЦА.
Таким образом, технический текст с информацией о потребительских характеристиках промышленных товаров и услуг выполняет две базовые функции:
Какие бывают типы технического информационного контента
Обилие типов технических текстов подразумевает получение предельно четкого ТЗ, в котором заказчик/клиент дает понять, что он хочет иметь: инструкцию или обзор, или что-то еще. Четко поставленная задача — залог успеха копирайтера.
Рерайт или копирайтинг?
Технические информативные тексты условно делятся на две категории: рерайт и копирайтинг.
Почему условно? Потому что, по сути, и в том, и в другом случае это будет переработка материалов. Пусть это будет информация не с других ресурсов, а с текстовых документов: инструкций, технических описаний и т. д.
Что отличает эти тексты?
Что представляют собой рерайт и копирайтинг в техническом тексте:
Например, последняя моя работа с ГК Остек для разделов сайта «Услуги», «Решения» относилась к категории копирайтинг, а описания категорий товаров типа: газовых горелок, твердотопливных и газовых котлов, частотных преобразователей и ИБП носили название рерайт. Был дан исходник, в котором перечислены технические характеристики и приведен текст с несколькими общими фразами. Вот здесь моя задача, как копирайтера была написать убедительный текст, который будет способствовать выбору оборудования нужного для решения клиентских задач.
Особенности технического текста для коммерческого сайта
Все вышеперечисленное встречал в требованиях ТЗ, в замечаниях после редактуры, просьбах заказчика.
О размере технической статьи
Когда «Палех» и «Баден-Баден» вытеснили заспамленные сео-ключами тексты, многим компаниям, предлагающим свои услуги в технической сфере, пришлось полностью перестраивать сайты. «Королев» вообще ориентируется на смысловое содержание статьи, для него неважно наличие ключей. Хотя я сомневаюсь, скорее всего «Королев» — это сырая разработка программистов и за ним грядет еще какой-нибудь «Кулибин».
Однако, сейчас не об этом. С появлением новых поисковых алгоритмов надобность в ключах почти исчезла, появилась другая фишка – полезность и величина статьи. Проверено на своем опыте, чем подробнее статья, тем быстрее она выйдет в ТОП поисковой ленты. Ориентировочный объем такого текста от 3 – 4 тыс. знаков и до «пока есть что сказать по делу». Не нужно злоупотреблять объемом – главное, руководствоваться принципами «золотой середины» и доводами разума.
Для того чтобы заставить прочитать статью используется не художественный оборот, а структура. Благодаря логически связанной структуре читатель прочтет текст полностью, но об этом ниже.
О полезности
Сайт – визитная карточка уважающей себя компании, поэтому его наполнение – важная веха в развитии бизнеса, которой отводится много времени и денег. Примеры будут ниже.
Однако это не значит, что для каталога, например, изоляционного материала нужно писать «километр» текста. Повторюсь: польза и свойства материала. При назначении цены, в этом случае руководствуются не знаками, а общей стоимостью или временем, затраченным на поиск материала. Поверьте, найти достоверную информацию и написать текст о стекломиканите (портфолио) на 1,5 – 2 тыс. знаков трудно.
Пример короткой статьи с полезной информацией. Первый абзац – описание категории материала и его свойств. Расшифровка марки материала. Ответ на вопрос: чем подтверждено качество материала. Область применения. Это важно. Таким образом, человек, зайдя на страницу сайта, сразу определит стоит ли читать дальше
Структура технического текста – вступление
По сути, рекламный бизнес-текст с содержанием научно-технического характера представляет собой многоплановую структуру, уровни которой последовательно подводят читателя принять положительное решение по выбору изделия.
Структура технических статей в зависимости от принадлежности к рерайту или копирайтингу отличается.
Структура технического текста – рерайт
В целом структура статьи для каталога, что для описания высоковольтного кабеля, что светодиодных осветительных устройств или частотных преобразователей, несмотря на различие, одинакова. Текст содержит:
Рассмотрим структуру статьи, описывающей асинхронный электродвигатель с фазным или короткозамкнутым ротором.
Структура статьи по категории товара — асинхронный электродвигатель
Структура технической статьи с описанием услуг – копирайтинг
Даже с подробным техническим заданием или брифом написать продающую статью сложнее, чем просто сделать продающее описание товара. Когда работал по статьям для раздела «Решения» энергоконсалтинговой компании, ТЗ было умопомрачительно подробным. По сути, ТЗ представляло собой содержание работы, вырванное из контекста проектировочной документации.
Поэтому структура сложной авторской статьи состоит из ответов на следующие вопросы:
Рассмотрим структуру статьи на примере услуг энергоконсалтинговой компании, а именно отделом «Энергоэффективности производства» ГК Остек. Пример: оказание услуг по целевому обследованию водовода крупного сибирского предприятия для определения утечки (потерь) воды (портфолио). Статья написана в соответствии с ТЗ. Материалы искались в Сети самостоятельно.
Структура статьи для описания услуг по целевому обследованию отделом энергоэффективности ГК Остек
Итак, со структурой технической статьи разобрались.
Как угодить клиенту, чтобы и девочкам интересно было, и техническая информация присутствовала
Для каждого ТЗ свои особенности, которые обязательно учитываются. Например, для магазина, предлагающего светотехническую продукцию, с которым я работал два года назад, основное условие заказчика было – писать, как для девочек, но чтобы текст был не менее 3000 символов и раскрывал технические свойства объекта описания.
Про себя подумал, когда получал заказ, это сколько же «воды надо налить», чтобы запилить такую статью. Это были seo-оптимизированные тексты, заточенные под конкретный запрос. Всего около 700 наименований категорий люстр, светильников различного типа от разных брендов.
В составлении структуры руководствовался следующими ориентирами:
Блажь, конечно, этот пример один из многих старых, двухлетней давности сторублевых seo-текстов, но заказчику понравился, а я удивился. Сейчас, по прошествии времени, очень многое поменял бы и полностью изменил статью. Тогда это была вынужденная мера продиктованная дедлайном, большими объемами работы, жесткими требованиями по seo и прочими не самыми комфортными условиями для работы.
Структура статьи для интернет-магазина светотехнической продукции, — продающее описание, с требованием заказчика: чтобы и девочкам было интересно, и технические описания присутствовали
Текст, согласно договору, делал с перелинковкой на соответствующие категории товара, это нужно для оценки изделия визуально в соответствии с описанием.
К тексту подбиралось изображение, демонстрирующее изделие в интерьере.
Прописывался дескрипшн и метатег title. Заголовок статьи – 6 или 8 слов для лучшего восприятия и для побуждения к прочтению. Заголовок должен интриговать и одновременно раскрывать суть.
Ключ содержится в метатегах, первом абзаце, желательно в заголовке и подзаголовке, примерно 3 – 4 раза равномерно раскидан по тексту.
Где брать материал
Изначально набираясь опыта в написании статей и получая заказы на технические темы, изучал информацию с соседних ресурсов. Пришел к выводу, что заполнение страниц на многих соседних сайтах написано в большинстве абсолютно безграмотными в техническом отношении людьми. Однако, кроме технических ошибок и «веселых» несуразиц, вызывающих улыбку, а иногда досаду, наблюдал, что многие технические тексты не хочется читать. Сплошное полотно букв, отсутствие структуры и мешанина фактов. А главное, бесконечное перечисление преимуществ именно этого магазина, обращения за помощью именно в эту контору.
Поэтому руководствуюсь своим алгоритмом написания статьи, информацию для технического текста предпочитаю брать не с соседнего ресурса, а пользуюсь следующими источниками:
Список популярных электрических форумов
Уникальность — это важно или нет
Уникальность – это всегда важно. Однако помните, что 100% уникальность никому не нужна, ей руководствуются создатели Г-сайтов, которые пасутся на текстовых биржах. Как говорит, мой хороший друг, опытный копирайтер Елена Котова: «Любая проверка настроена на какое-то сочетание слов. Они все были и существуют, миллионы раз повторяясь. Оценивать надо весь текст в комплексе». Читайте подробнейшую статью «За кулисами полезного контента» на ее блоге. Свое мнение об уникальности и особенностях размещения статьи на сайте высказал в статье «Некоторые правила по написанию и размещению статей, известных большинству копирайтеров».
На этом завершу статью. Надеюсь, что несмотря на объем, она оказалась вам полезной. Не нужно руководствоваться моим рассказом, как постулатом, это всего лишь мой рабочий опыт, который я, хочу думать, вам поможет. Понравилась статья, жмите на спасибо, так я пойму, что делал ее не зря.