Техническое письмо - это одна из самых сложных работ, поскольку писатель должен излагать высокотехнологичную информацию в понятной и ясной для аудитории форме.
Технические статьи не должны быть слишком сложными для восприятия, затянутыми или грамматически неправильными. И порой найти хорошие технические руководства, которые были бы просты и понятны для чтения, - довольно утомительная работа.
Ваше техническое письмо может быть в любой форме, например
-
Инструкция или руководство пользователя
-
Учебный курс
-
Описания продуктов
-
Белые книги
-
Руководства по продукции
-
Справочные руководства
-
Годовые отчеты и многое другое
В эту быстро развивающуюся цифровую эпоху технические писатели должны использовать определенные стратегии для достижения истинного вовлечения читателей. Действительно, это огромный вызов!
Поэтому в этом посте мы дадим вам несколько замечательных советов и рекомендаций по привлечению читателей при написании технических руководств:
Основные задачи технического писателя
![] (https://cdn.docsie.io/workspace_PfNzfGj3YfKKtTO4T/doc_JLDSpWBDcIaMWR3Ce/file_K9C0MKI3LgOVvRHIC/56aae035-c94c-f464-32cc-f7811ec34cdeimage.jpg)
1. Знать аудиторию
Анализируя целевую аудиторию, технические писатели должны определить стиль, тон, длину и формат своего письма.
Не зная личности вашей аудитории, вы можете написать слишком простые или слишком сложные технические статьи. А мы этого не хотим.
Нужно стараться найти идеальный баланс между проницательностью, знанием и понятным изложением информации.
2. Читабельность
Читабельность - один из ключевых факторов привлечения технических читателей, поскольку именно показатель читабельности определяет, насколько доступным является ваше сообщение. Читателям не должно быть трудно ориентироваться в вашем техническом руководстве или понять уровень используемого языка.
Писатели должны стараться внедрять удобный для пользователя язык с оптимальным стилем и форматом, который должен быть информативным и в то же время простым.
3. Точность
Статистика, факты и утверждения в документе всегда должны быть перепроверены и подкреплены доказательствами или отчетами об исследованиях, приведенными из надежных источников. В противном случае представленная информация может потерять свою достоверность и надежность в глазах общественности.
Для достижения вышеупомянутых целей технический писатель должен использовать следующие стратегии:
-
Передавать техническую информацию в простой, кристально ясной манере, так, чтобы даже нетехническая аудитория могла ее понять.
-
Использовать методы и инструменты, которые улучшают технический контент.
-
Эффективно излагать технические предложения, идеи, представления, взгляды и наблюдения в стратегической последовательности.
-
Использовать правильный тон лексики с точной структурой для иллюстрации отчетов, документов или презентаций.
12 лучших советов, которые следует применять при написании технического руководства, чтобы заинтересовать читателей
![] (https://cdn.docsie.io/workspace_PfNzfGj3YfKKtTO4T/doc_JLDSpWBDcIaMWR3Ce/file_CDo3jPQUeYxiW9peG/e2f448b6-580d-4a86-4cca-f34aaea0a88eimage.jpg)
1. Проанализируйте знания вашей аудитории
Технические руководства должны быть информативными и глубокими. При написании такого контента писателю необходимо проанализировать, насколько аудитория уже разбирается в технических понятиях, связанных с темой.
Не нужно интерпретировать темы, в которых ваша аудитория уже хорошо разбирается. В то же время нелогично пропускать понятия, в которых ваша аудитория, возможно, не имеет базового понимания. В обоих случаях ваша аудитория, скорее всего, потеряет интерес или сочтет ваше техническое руководство либо слишком сложным, либо излишне затянутым.
Ключевым моментом здесь является анализ базовых знаний и возможностей вашей аудитории, а затем предоставление ей информации, которая заложит прочный фундамент знаний о предмете и в то же время будет познавательной.
2. Глубокое исследование
Написание технического контента требует всестороннего исследования и точной информации, подкрепленной корректными статистическими данными или фактами. Именно это придает вес и ценность вашему техническому контенту; следовательно, это самый важный фактор для привлечения читателей.
Проведите детальный анализ контекста и технической информации, например:
-
Сбор информации, связанной со всеми техническими аспектами темы, включая объем, особенности, процесс проектирования, спецификации, правовые рамки и т.д.
-
Изучение юридических договоров и их требований. Техническое содержание должно соответствовать действующим нормативным стандартам. Следовательно, необходимо следить за соблюдением правовых требований.
-
Проанализируйте целевую аудиторию и адаптируйте контент в соответствии с пониманием и требованиями целевой группы пользователей. Это включает в себя различные аспекты, такие как графика, уровень языка, тип носителя, читабельность, уровень сложности и т.д.
3. Структура представления
При передаче технических знаний в форме руководств или пособий структура и формат играют жизненно важную роль.
Технические руководства и так немного сложны для понимания, поэтому не стоит внедрять в структуру дополнительные сложности. Развивать вовлеченность в такой контент становится сложно.
Чтобы донести ценность до аудитории, писатель должен продумать, как структурировать контент таким образом, чтобы его хотелось воспринимать.
4. Визуальные эффекты и графика
Использование изображений, связанных с техникой, которые визуально привлекательны и в то же время информативны, не только тактически разобьет контент, но и привлечет ваших читателей.
Сфера внимания современных читателей кажется короткой. Поэтому техническое руководство с изображениями сделает ваш контент более легким для навигации, плавным и поможет вам разбить длинные блоки текста.
В то же время не переборщите с количеством изображений, так как они могут затмить реальную техническую информацию. Постарайтесь найти хороший баланс между текстом и визуальным представлением.
5. Примеры обязательны
Примеры способны облегчить понимание сложных тем. Разъясните сценарий в реальном времени, который перекликается с темой на картинке, чтобы ваша аудитория поняла ее более эффективно. Технические писатели могут даже использовать образы в качестве примера, а затем объяснить его.
6. Озвучьте правильно
Зачастую техническое руководство может звучать обыденно, нейтральным тоном, а так быть не должно. Ваше техническое руководство должно иметь свой собственный голос, и один из лучших способов привить его - использовать точку зрения от первого лица.
При написании от первого лица не забывайте сохранять авторитетный и профессиональный подход.
7. Используйте простой язык
Техническое письмо не должно быть сложным, просто потому что оно охватывает высокотехнологичные темы. Когда вы пытаетесь определить технические концепции, процессы или методы, старайтесь идти в ногу с техническим творчеством, не переусложняя.
Один из самых распространенных виновников неудачного письма - не учитывать тот факт, что читатели могут не разбираться в определенных понятиях. В этом случае велика вероятность того, что ваша аудитория будет чувствовать себя непонятой, некомфортной и менее вовлеченной.
Стандарты простого технического английского языка (STE) повысят переводимость и читабельность вашего документа.
Постарайтесь написать техническое руководство с использованием следующих правил:
-
Простая структура предложений
-
Активный голос
-
Последовательные термины
-
Простые времена глаголов
Другими словами, старайтесь быть простыми и краткими.
8. Уточните крючок
В самом начале вашего технического руководства определите "крючок" вашего контента - то, что читатели узнают из вашего руководства. Быстро обрисуйте техническое содержание и объясните все области, о которых пойдет речь в вашей статье, чтобы ваши читатели знали, чего ожидать.
Это позволит вашим читателям почувствовать удовлетворение и удовлетворение, когда они закончат чтение всего руководства. Никто не хочет читать целый блок контента, чтобы в конце понять, что это не та информация, которую они искали.
9. Макет имеет важное значение
Макет - один из эффективных способов сделать ваш технический контент более увлекательным и читабельным, при этом акцентируя внимание на ключевых областях.
Стратегически используйте разрывы страниц, маркированные пункты, нумерованные списки, ключевые слова, выделенные жирным шрифтом, и таблицы, чтобы выделить важные моменты и привлечь внимание к нужным разделам.
10. Избегайте ссылок на конкретный период времени
Чтобы ваш технический контент оставался актуальным в течение длительного периода времени, убедитесь, что вы не ссылаетесь на конкретный год, например, "в 2021 году" или "в этом году". Использование этих фраз ограничивает и датирует ваш контент определенным периодом времени и снижает его актуальность в долгосрочной перспективе.
Убедитесь в том, что ваш контент рассчитан на будущее, не используя ссылки на конкретное время; постарайтесь сделать его более общим.
11. Будьте остроумны
Даже если это технический контент, постарайтесь добавить немного юмора или остроумия, чтобы сделать его легким. Это один из самых простых и эффективных способов зацепить аудиторию.
12. Просмотрите свой технический документ
Всегда разумным шагом является однократный просмотр вашей технической документации экспертами предметной области (SME) для проверки содержания. Это не только даст вам бесценные знания, но и избавит от грамматических ошибок.
Заключение
![] (https://cdn.docsie.io/workspace_PfNzfGj3YfKKtTO4T/doc_JLDSpWBDcIaMWR3Ce/file_5QOqgtxaRoDpvSNia/4a864066-4b80-37ed-6a09-0fc854ef6724image.jpg)
На этом мы заканчиваем наш творческий пост о том, как привлечь читателей при написании технического руководства. И последнее, но не менее важное: убедитесь, что вы всегда подкрепляете свои утверждения и факты правильными источниками информации, такими как статистика, отчеты, исследовательские работы и т.д.
Кроме того, как только вы закончите, пересмотрите свой технический документ и убедитесь, что он ясен, точен и актуален. Вот и все!