Как составить ТЗ дизайнеру и копирайтеру

Как составить техническое задание для дизайнера и копирайтераadmin21.12.202120.05.2022

1. С чего начать: подготовка к составлению ТЗ
   •  Структура: что включает в себя ТЗ для дизайнера и копирайтера
2. Ошибки при составлении технического задания
   • Типичные ошибки при написании ТЗ
3. Рекомендации на примере кейса: как правильно составлять ТЗ
4. Как составить ТЗ для копирайтера и дизайнера

Техническое задание (ТЗ) – это документ, служащий руководством для копирайтера и дизайнера при выполнении поставленной задачи. От правильно составленного ТЗ зависит качество итоговой работы и ее соответствие ожиданиям – вашим и заказчика. В статье разберем все, что нужно учесть.

С чего начать: подготовка к составлению ТЗ

Ключевой момент в подготовке к составлению технического задания – понять, как должен выглядеть результат. Ответьте себе на вопрос: чего именно вы хотите добиться от дизайнера или копирайтера? Ниже обозначены предварительные шаги маркетолога или SEO-специалиста, необходимые для того, чтобы написать ТЗ исполнителю.

Техническое задание для копирайтера

Техническое задание для дизайнера

• Выбираем тему текста. Здесь поможет подбор популярных запросов в нужной вам тематике, а также поиск наиболее обсуждаемых тем среди целевой аудитории (например, в группе компании-заказчика в социальной сети).
• Анализируем тексты конкурентов. Изучите, как раскрывается выбранная тема в топовых статьях поисковой выдачи. Отмечайте для себя структуру и средний объем статей.
• Собираем семантическое ядро. Для успешного ранжирования статьи в поисковых системах необходимо использовать инструменты SEO. Используя лучшие статьи конкурентов, определите главный и второстепенные ключи по выбранной теме. Также рассчитайте необходимую плотность ключевых слов в тексте. Это легко можно сделать с помощью сервиса Яндекс.Wordstat. На этом же этапе составляются Title и Description.

• Готовим контент. Задача дизайнера – визуализация идеи, которую нужно донести до целевой аудитории. Тексты, заголовки и слоганы должны быть продуманы заранее.
• Подбираем референсы. Займитесь поиском примеров удачного дизайна. Сохраняйте ссылки и делайте скриншоты. Лучше ограничиться пятью ресурсами, так как чрезмерное разнообразие может запутать. Если требуется разработать дизайн всего сайта, необязательно тратить время на поиск ресурса, полностью выполненного в соответствии с требованиями. Можно, например, использовать в качестве примеров расположение иллюстраций на одном сайте, и оформление меню – на другом.
• Рисуем прототип на бумаге. Художественные навыки не требуются: схематичное отображение того, что вы хотите получить, существенно упростит задачу дизайнера.

Структура: что включает в себя ТЗ для дизайнера и копирайтера

После подготовки переходим непосредственно к составлению ТЗ. Имейте в виду, что то, что кажется очевидным вам, не всегда очевидно исполнителю. Разберем пункты, наличие которых делает документ максимально полным и понятным.

Техническое задание для копирайтера

• Тема. Название статьи, можно несколько вариантов на выбор с учетом ключевого запроса.
• Тип текста. Что пишем: продающий текст, информационную статью, карточку товара, развлекательный пост для социальной сети. 
• Цель текста. Чего хотим добиться текстом: например, мотивировать на заказ услуги или помочь с выбором товара.
• Информация о компании. Сфера деятельности компании заказчика, специфика бренда, конкурентные преимущества, tone of voice.
• Целевая аудитория. Описание читателя/клиента: на кого должен быть ориентирован текст.
• Объем. Количество символов без пробелов.
• Структура. Наличие вступления и заключения, разбивка на абзацы, количество заголовков и подзаголовков. 
• Список ключевых слов. Ключи, которые необходимо органично использовать в тексте.
• Title и Description. Метатеги, прописанные SEO-специалистом. Копирайтеры, как правило, не придумывают их сами.
• Ссылки. Адреса ссылок на другие статьи, которые необходимо вставить в текст.
• Требования к стилю. Можно взять за основу общепринятые стили: деловой, публицистический, научный, разговорный. Затем конкретизировать: нужна ли максимальная лаконичность или, наоборот, эмоциональная окраска. 
• Требования к оформлению. Всё, что касается шрифтов, выравнивания текста, отступов, списков, таблиц и изображений.
• Формат сдачи работы. Файл Microsoft Word или ссылка на Google Docs.
• Уникальность. Идеальный показатель – 100 %. Добавьте ссылки для проверки: text.ru или advego.com
• Водность и заспамленность. Допустимый процент «воды» и спама с упоминанием сервиса для контроля.
• Грамотность. Напоминание не помешает. Можно дать ссылку для проверки: например, https://orfogrammka.ru/.
• Сроки выполнения. Четкий дедлайн без диапазона дат. Лучше обозначить с запасом, оставив время на правки.

Техническое задание для дизайнера

• Постановка задачи. Над чем работать: нарисовать макет веб-сайта, мобильного приложения, шаблон для e-mail-рассылок.
• Информация о компании. То, что может помочь в поиске уникального стиля бренда: сфера деятельности и конкурентные преимущества. Особенно полезной будет ссылка на брендбук.
• Целевая аудитория. Описание тех, для кого будет создаваться визуальный контент.
• Цель дизайна. Привлечь больше клиентов, увеличить дочитываемость статей, выделиться на фоне конкурентов – каждая цель требует определенного подхода при визуализации. Например, лучше прописать, что вы хотите увеличить число кликов на кнопку, чем «кнопка должна быть большой и красной».
• Цветовая палитра. Перечень и описание цветов, которые можно использовать и тех, которые следует избегать. Если у бренда есть фирменные цвета, указать их.
• Подходящие шрифты. Скриншоты или ссылки на понравившиеся шрифты, например, в fonts.google.com
• Наличие элементов и описание их стиля. Требования к внешнему виду кнопок, формы подписки, шапки, футера и других элементов – это особенно актуально при заказе дизайна сайта. Четко пропишите, что должно быть отражено в макете. А о том, из чего должен состоять сайт компании, читайте в нашей статье
• Референсы. Примеры удачных и неудачных дизайнерских решений с указанием того, что именно нравится/не нравится. Идеально, когда есть и ссылки, и скриншоты.
• Прототип. Простой рисунок, сделанный от руки или в Paint, отражающий ваше видение результата. Дизайн – это все-таки про визуализацию, и многие моменты очень трудно расписать и объяснить устно.
• Сроки выполнения. Как и в случае с ТЗ для копирайтера, ставьте четкий срок с учетом время для исправлений и доработок.

Ошибки при составлении технического задания

Типичные ошибки при написании ТЗ

Разговор о том, как правильно составлять ТЗ для дизайнера и копирайтера, нельзя оставить без упоминания типичных ошибок. Их можно свести к двум основным.

• Размытая постановка задачи и недостаток информации. Краткость в случае технического задания не работает и грозит либо получением шаблонной статьи, либо безликого дизайна. Всё, что вы не пропишете в ТЗ, исполнитель постарается додумать. И не факт, что его догадки совпадут с вашими идеями. 

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

Не стесняйтесь давать полную информацию о компании и целевой аудитории. Если не хотите перегружать само ТЗ, вставьте в него ссылку на бриф заказчика или брендбук. Так копирайтер сможет создать уникальный по смыслу текст, а дизайнер – разработать логотип или макет сайта в соответствии с видением конкретного бизнеса. А о том, как подобрать тип сайта для бизнеса, читайте в нашей статье на эту тему

• Отсутствие примеров. В случае с дизайнерами этот момент принципиален: лучше один раз показать, чем использовать массу эпитетов при описании, а потом неприятно удивляться результату. Полезно добавить и негативные примеры, желательно с пояснением, почему так делать нельзя. Обозначьте табу и для сохранения оригинальности: дайте ссылки на страницы конкурентов, и это поможет избежать случайного или намеренного копирования, например, цветовой гаммы.

Копирайтеру, особенно при работе со сложной, узкопрофильной тематикой,  лучше  выслать несколько ссылок на удачные тексты. Обязательно поясните, что именно вам нравится – манера изложения, наглядные графики или легкий юмор.

Помните, что многочисленные правки – часто следствие некорректно составленного ТЗ. И подходя к его написанию серьезно, вы экономите в том числе и свое время. Подробнее о том, как сэкономить при создании сайта

Рекомендации на примере кейса: как правильно составлять ТЗ

Теперь посмотрим на примере технического задания для копирайтера. Допустим, вам нужен текст о том, как подобрать женскую стрижку, для размещения на сайте студии красоты.

Для начала составим плохое ТЗ:

Очень вероятно, что итоговый текст, написанный по такому “руководству”, расстроит вас.  

Теперь приложим немного усилий – и вот что получилось:

Как составить ТЗ для копирайтера и дизайнера

В статье мы разобрали, как подготовить и составить ТЗ для дизайнера и копирайтера. Мы отметили наиболее частые ошибки и на примерах показали отличие правильного технического задания от написанного «на скорую руку». Уделяя время тому, чтобы донести информацию подробно и четко, вы увидите, что результат принимаемой работы становится более качественным, а правки – минимальными.

Помощь в составлении технического задания

Получить консультацию

Подписаться

Я согласен на обработку персональных данных

Почему мы пишем ТЗ сами

Ответ на этот вопрос плюс примеры техзаданий на промдизайн, а также шаблон ТЗ и инструкция по его заполнению

Клиент (да и человек вообще) ленив по своей природе. Редко кому нравится детально описывать, что ему надо: хочется, как у Apple — нажал на кнопочку и получил понятный результат.

Волшебной кнопочкой применительно к разработке корпусов выступаем мы, Формлаб. Техническое задание на разработку корпуса в Формлабе всегда пишут сами, и не только потому, что у заказчика часто не хватает времени на ТЗ. Это один из тех сервисов, которые появились у нас практически с момента основания бюро.

Почему мы так работаем? Есть причины — давайте посмотрим.

Спойлер: здесь будут не только ответы на «Почему?» и рецепт «Как написать хорошее ТЗ на промдизайн», но и мини-руководство «Как исправить плохое техническое задание». А ещё — опросник для заказчика, инструкция по заполнению техзадания и реальные примеры.

Потому что так проект быстрее выйдет на старт

Конечно, все мы очень любим, когда задача приходит в виде многостраничного документа, где описано всё, что можно — компоновка, материалы, производство, экономика и т.д. Но такие задания — если судить по практике — можно увидеть в лучшем случае раз в месяц. Чаще встречаются другие.

Возьмем пример слегка экстремального случая. Бывшее РИА «Новости», которое сейчас МИА Russia Today, в 2015 году объявило тенедер на лучший дизайн маршрутизатора (по ТЗ — «устройства передачи данных в сетях трёх операторов сотовой связи»). Это оказалась задача из разряда: «Мы не знаем, как оно должно выглядеть, но у нас есть спецификация с комплектухой».

Какие-то мысли относительно свойств будущего корпуса у клиента всегда есть. Они бродят в его голове, иногда вырываясь наружу в виде хаотичных набросков, заметок, замечаний или высказываний. Но вот сделать на основе этого «чего-то» некий структурированный документ, понятный любому непосвященному, —это огромные энергетические и трудозатраты. Сам заказчик чаще всего заявляет нечто вроде: «Нужен корпус космолёта. Пришлите ваши вопросы, мы на них ответим».

Космолётов много. Только вот какой из них понравится заказчику? Поди угадай

Однако мы примерно представляли, что нужно будет сделать: во-первых, в активе Формлаба уже был похожий проект — модем Hornet.

Промышленный модем Hornet — опыт разработки таких устройств у нас уже был

Во-вторых (и в-главных), у нас уже есть некая шаблонная схема написания ТЗ в виде опросника. Лишних вопросов там нет — всё проверено многими годами практики. То есть мы заранее знаем, что будем спрашивать у клиента.

Хотите посмотреть на список вопросов — жмите на кнопку и качайте опросник.

Опросник для формулировки технического задания:

Скачать

Возвращаемся к маршрутизатору: раз есть спецификации на электронику, значит, имеются и кое-какие исходные данные. Так, в состав этого роутера должны входить три модема и модуль Wi-Fi; на корпусе нужны разъёмы Ethernet, micro-USB, SMA. Есть монохромный дисплей. Материал основной части корпуса — фрезерованный алюминий, панель — пластик, кнопки — тоже алюминиевые. Уже что-то можно придумать.

Смотрим на аналогичные разработки:

За сутки с небольшим рисуем эскизы:

К устройству присоединяются 6 внешних антенн. То есть обязателен рисунок хотя бы с парой из них.

Выбираем самый, на наш взгляд, удачный вариант. Готово:

Итого: быстро дать старт проекту позволит использование шаблона-опросника. Этот шаблон помогает написать ТЗ:

• даже в том случае, если этих данных мало или почти нет;
• достаточно быстро;
• в очень легкой и ненавязчивой форме — ответы на вопросы можно получить даже во время телефонного разговора.

Если проект, конечно, не относится к разряду самой сложной разработки на свете.

Отрывок из ТЗ на маршрутизатор, которое мы написали сами по шаблону

Окончание разработки дизайна без ТЗ — модель и рендеры.

«Самый правильный заказчик» (с), конечно же, ТЗ пишет сам. Но такие люди встречаются редко. Как правило, они уже много лет «варятся» в разработке и наизусть выучили все подводные камни.

Потому что сделанное самостоятельно ТЗ покажет то, о чём сам клиент никогда не расскажет

Клиент может знать о корпусе устройства что-то очень важное. Но вам об этом никогда не расскажет. Не корысти ради и не по той причине, что ждёт, что вы сами об этом догадаетесь, — всё проще. Он просто может не подозревать, что вам эта информация нужна.

Пример: клиент не сообщил нам, что корпус панели управления охранной сигнализацией будут регулярно вскрывать, чтобы провести его техобслуживание. Соответственно, в ТЗ это отражено не было.

Корпус панели управления, о регулярном сервисном обслуживании которой в техзадании ничего сказано не было

Как следствие, защёлки, на которых крепилась задняя стенка, начали отваливаться, покупатели — жаловаться, а сам проект через пару лет после запуска умер. Подробности разработки здесь.

Мы пишем ТЗ потому, что так начать проект быстрее и проще; потому, что мы умеем это делать оперативнее и эффективнее, чем если бы заказчик делал это самостоятельно, и по той причине, что мы получим те вопросы, ответы на которые клиент нам не даст сам. Потому что не даст.

Потому что иногда ТЗ — это одновременно и исследование в рамках проекта

Например, как-то раз мы разрабатывали домашний мини-пресс для мусора. В ТЗ вошли несколько кинематических схем, чтобы отработать их в рамках проекта. Обычному заказчику почти наверняка такое окажется не под силу.

Идея этого пресса: кладешь в мусорное ведро-пресс пакет, кидаешь мусор, ведро трудолюбиво сжимает его, а когда оно наполняется, ты вытаскиваешь из устройства уже спрессованный, в запаянной пластиковой упаковке компактный брикетик и торжественно несёшь на помойку. Просто и красиво.

Прототип мусорного ведра-пресса

Когда заказчик рассказал о своей идее, было всё понятно. Но в тот момент, когда мы начали писать ТЗ, выяснилось, что не понятно вообще ничего, и здесь разработка техзадания стала отдельным подпроектом. Задание писал конструктор.

Кстати, опытный образец этого пресса был способен легко и непринуждённо сжимать даже бутылки из-под шампанского.

Потому что ТЗ — это не памятник

В 99% случаев в процессе разработки ТЗ изменяется. Дизайн, условно говоря, ты в миллиметрах не опишешь. Сначала мы делаем ТЗ «первого уровня» — черновик, к моменту начала разработки задание уточняется, и в нем описывается вообще всё, что можно уточнить. С этого момента техзадание становится основным внутренним документом, помогающим нашим разработчикам взаимодействовать со спецами клиента.

Но надо помнить, что ТЗ — это не истина в последней инстанции. Документ описывает идеальный результат разработки, такого сферического коня в вакууме.

Надгробная плита увековечивает память. ТЗ ничего такого не увековечивает, а лишь обозначает границы

Но одновременно это НИОКР, условия постоянно меняются: то выясняется, что изначально подобранная электроника не умещается в корпусе, поэтому надо либо менять габариты корпуса, либо начинку; то выясняется, например, что уже утверждённый в составе компонентов дисплей сняли с производства, и поэтому его срочно придётся заменять другим. Поэтому ТЗ — не аксиома и не волшебная шляпа: закинул в неё пожелания и вынул готовый результат. Оно лишь обозначает красные флажки вокруг разработчика.

Важно: у хорошего разработчика не бывает расхождений с ТЗ, не согласованных с заказчиком. Все версии техзадания нужно согласовывать с заказчиком.

Бывает и так, что ТЗ у заказчика уже есть. Это всегда замечательно, но не всегда полезно для разработки (как, например, в упоминаемом выше случае с прессом для мусора: заказчик может описывать одно, а иметь в виду немного (или совершенно) другое).

Но есть также и методы борьбы с этим явлением.

Два способа исправить плохое ТЗ

Отличить плохое ТЗ от хорошего просто.

Первый критерий: кейсы от пользователей с описанием недостатков/неудобства использования/слабых сторонах предыдущего изделия (если это не разработка с нуля, конечно). Соответственно, в хорошем и годном должен быть анализ недостатков предыдущей модели.

Второй критерий: отсутствие или наличие упоминаний о конкурентах. Это вообще большая проблема: люди неправильно оценивают тех, кто с ними конкурирует, или вообще не смотрят на тех, кто делает почти то же самое, что и они. А зря: как правило, конкуренты уже решили какие-то проблемы устройства, уже вложились в разработку. Игнорируя это, ты будешь набивать те же самые шишки, что когда-то — конкуренты, но уже за свои деньги. Заниматься промышленным шпионажем здесь вряд ли придётся, достаточно хорошо изучить то, что производят другие и попробовать понять, почему они так сделали.

Первый способ исправить ТЗ

Начинать формулировать лучше с главного и крупного — что именно в новом приборе сможет продавать его сильно лучше. Вместе с клиентом определите цель разработки. Например, цель заключается в том, чтобы начать продавать обновлённую версию прибора вдвое дороже или вдвое большему количеству покупателей? Или чтобы пользователи перестали писать в своих отзывах что-то вроде «это сделано из дешёвой пластмассы, фу», «нормально вымыть это невозможно», «постоянно натыкаешься на острые части корпуса»?

С ответом на вопрос: «Для чего?» могут помочь в отделе продаж (и / или маркетинга тоже) заказчика. Скорее всего, там наблюдают за конкурентами уже сейчас и совершенно трезво сравнивают себя с ними, слушают возражения клиентов и могут выявить то самое свойство изделия, которое надо прописать как стержень ТЗ, сделать основной задачей проекта — добавить или усилить именно это свойство нового продукта.

Потом надо пойти к промышленным дизайнерам и попросить показать продукт под «хотелки» продавцов — именно в этот момент он получит визуальный образ, и всем станет легче додумывать. Проверено годами: с картинкой обсуждение проекта быстрее переходит в практическую и конструктивную плоскость.

С этой картинкой уже можно идти к электронщикам и спрашивать: «Вот такая штука нужна, когда сделаете?» Электронщики вам крылья, конечно, подрежут, но это уже рабочий процесс…

Второй способ

Когда не подходит способ №1, т.е. продавцы не могут сформулировать, что нужно, идите сразу к промышленным дизайнерам. Задача для них получится и сложнее, и проще одновременно. Они должны будут собрать «хотелки» со всех слоёв проекта, а из всего, что соберётся, сделать задачу для себя.

Упоминая «всех», я имею в виду действительно всех — от уборщицы и бухгалтерши до Василь Степановича, который будет коробки грузить на производстве. Промышленный дизайнер должен стать коммуникатором между всеми вами (и руководство — это тоже еще одна точка постановки задач и ограничений) и клиентом вашего продукта. Я не могу судить, должен это быть штатный дизайнер или наемный работник со стороны. Был с обеих сторон баррикад и вижу и там, и там свои плюсы/минусы.

Ну и Формлаб не был бы Формлабом, если бы не давал вам в руки инструментов для работы проектных команд. Вот наш внутренний шаблон технического задания с простой инструкцией по заполнению. Скачивайте, пользуйтесь.

Техническое задание с инструкцией по заполнению и примерами:

Скачать

— Для промышленных дизайнеров ТЗ — это всё же больше бумажка для клиента. Мы не конструкторы, для которых важен каждый миллиметр. Но техзадание нужно — для того, чтобы мы с клиентом смотрели в одну сторону.

Андрей Востриков,
руководитель бюро инженерного дизайна ФОРМЛАБ

Примеры технических текстов: 3 разных типа

• ОПИСАНИЕ

  техническое руководство и планшет

• ИСТОЧНИК

  pandpstock001 / iStock / Getty Images Plus

• РАЗРЕШЕНИЕ

  Используется по лицензии Getty Images

Вы когда-нибудь читали инструкцию по эксплуатации? Затем вы видели пример технического письма. Техническое письмо бывает разных форм. Получите разбивку типов технического письма и их примеры, чтобы узнать, подходит ли вам эта профессия.

Различные типы технического письма

Техническое письмо — это письмо, предназначенное для обучения, информирования или направления кого-либо о том, как что-то делать. Он значительно отличается от других типов письма, таких как повествовательное письмо, потому что техническое письмо предназначено для передачи определенных навыков или способностей. Он также часто очень ориентирован на детали и включает в себя написание в областях, где требуются расширенные знания.

Технические письменные задания обычно принимают одну из трех форм:

• документация для конечного пользователя
• традиционное техническое письмо
• технические маркетинговые коммуникации

реклама

документация для конечного пользователя

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

См. несколько примеров различных технических текстов документации для конечного пользователя:

• руководство пользователя, прилагаемое к сотовому телефону
• руководство пользователя, обучающее пользователей домашних компьютеров настройке базовой домашней сетевой системы
• практическое руководство по использованию ноутбуков
• руководство по настройке и установке
• описание document

Традиционное техническое письмо

Традиционное техническое письмо пишется аудиторией, имеющей определенный опыт для своих коллег. Погрузитесь в несколько примеров традиционного технического письма:

• анализ судебного дела для других юристов
• краткое изложение серии медицинских экспериментов для публикации в медицинском журнале
• отраслевая статья для отраслевого издания оплачиваемый отпуск
• Часто задаваемые вопросы для компании
• технические спецификации и документация API
• информационные документы, такие как технический документ

реклама

технические маркетинговые коммуникации

Иногда техническому писателю необходимо внести свой вклад в маркетинговые материалы для продукта. В этой ситуации писателю необходимо передать свой опыт более удобным для пользователя языком, чтобы помочь потенциальному покупателю понять и заинтересоваться продуктом.

См. несколько примеров технических маркетинговых коммуникаций:

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

Реклама

Примеры of Technical Writing

Техническое письмо используется в различных областях, таких как машиностроение, компьютерное оборудование и программное обеспечение, химия и биотехнология. Вы также можете найти повседневные примеры технического письма в руководствах пользователя, справочниках сотрудников и веб-статьях.

Некоторые примеры технических письменных заданий включают:

• учебные пособия, предназначенные для информирования новых сотрудников об их роли
• руководства по эксплуатации определенных инструментов и продуктов
• рекламные брошюры, побуждающие сотрудников и клиентов воспользоваться предложениями компании
• онлайн статьи, которые могут быть информативными или убедительными, но требуют определенных технических знаний
• пресс-релизы для публикации официальных новостей компании

Учебные пособия

Техническому писателю может быть поручено собирать информацию для компании или руководства по профессиональному обучению. В руководстве от автора может потребоваться выделить несколько областей, таких как:

• общая информация, такая как местонахождение работодателя и часы работы
• политика компании, например, оплачиваемый отпуск и политика хронометража форматирование и редактирование запроса предложений (ЗП)
• обязанности, которые должны выполняться данной должностью, которые будут уникальными для рассматриваемой должности

Учебные пособия и другие документы компании обычно можно отнести к категории документации для конечного пользователя.

Реклама

Пример неформального письменного предложения

Нажмите, чтобы посмотреть и скачать

Руководства по эксплуатации

Когда автора просят написать руководство по эксплуатации, он ожидает, что он будет иметь практические знания в данной области. Важно иметь в виду, что люди, которые будут использовать руководство, скорее всего, будут новичками. Поэтому им нужна подробная и краткая инструкция. Руководства по эксплуатации могут включать конкретные рекомендации, в том числе:

• инструкции по сборке данного продукта
• руководства по установке для интеграции продукта в совместимые системы
• руководства пользователя, охватывающие несколько тем для нового владельца продукта взаимодействие с другими системами
• технические руководства, в которых рассматриваются конкретные технические вопросы, связанные с продуктом

Руководства по эксплуатации обычно относятся к категории традиционных технических документов, но в некоторых случаях они также могут считаться документацией для конечного пользователя.

Реклама

Рекламные брошюры

Технический писатель, который пишет рекламные брошюры и другие технические маркетинговые материалы, должен информировать потенциального клиента о сделанном предложении и побуждать его к покупке посредством использования ключевых фраз. Это может включать маркетинговые электронные письма, рекламные письма и листовки о продуктах, а также другие типы рекламных материалов.

Детектив

Нажмите, чтобы посмотреть и скачать

Онлайн-статьи

Еще один тип технического письма — онлайн-статьи. Существует огромное количество информации, доступной в Интернете. Миллионы людей просматривают поисковые системы, читают статьи, которые они находят в поисках инструкций и руководств, и понимают разные вещи.

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

Пресс-релизы

Пресс-релиз, созданный техническим писателем, представляет собой официальный документ, сообщающий новости о потребителях компании. Пресс-релизы короткие, но они все равно должны побуждать читателей хотеть узнать больше. Например, Apple выпустила пресс-релиз с новой информацией о своей компании от продуктов до открытия нового кинотеатра. Пресс-релизы должны включать заголовок и обзор информации, а также контактную информацию компании. Пресс-релиз относится к категории маркетинговых коммуникаций.

Шаблон пресс-релиза

Нажмите, чтобы посмотреть и скачать

Если у вас было техническое письменное задание, в рамках которого вас попросили написать руководство пользователя, показывающее различные аспекты продукта, вы могли бы начать с чего-то вроде этого образца. В нем подробно рассказывается об использовании вымышленного автоматического игрального автомата Dantel.

1. Ручное управление: Добавьте все кости в квадратное отверстие вверху. Кости выйдут из ролика через отверстие в дне на стол. При использовании в ручном режиме подключение ролика к сети не требуется.
2. Цифровое управление: При подаче электроэнергии на автоматический каток Dantel прямо над выходным отверстием отображается цифровое время. При использовании в цифровом режиме добавьте нужные кубики на вершину квадратной башни. Нажмите кнопку, расположенную чуть выше цифрового показания времени. Как только кнопка начнет мигать, создайте интервалы для выпуска кубиков через отверстие.
3. Управление Bluetooth: Dantel совместим с Bluetooth. Чтобы использовать эту операцию, загрузите приложение Dantel из цифрового магазина. После загрузки используйте приложение, чтобы создать интервалы для выпуска кубиков на стол.

Поиск технических текстов

Как видите, существует множество различных типов технических текстов. Если вы заинтересованы в том, чтобы стать техническим писателем, вам следует подумать о том, чтобы поработать над своими навыками письма и вашими специфическими отраслевыми знаниями, чтобы найти наилучшие возможности. И знание того, что искать, может уберечь вас от поиска или создания плохих примеров технического письма. Один отличный способ увеличить ваши шансы найти работу по техническому письму — составить идеальное резюме и сопроводительное письмо. С помощью и немного удачи вы найдете именно то, что вам нужно.

Задачи технического письма

Марк Никол

Если вы когда-либо читали руководство по эксплуатации, вы знаете, что такое техническое письмо, хотя оно бывает и во многих других формах. Три основные категории технического письма:

• документация для конечного пользователя, которая помогает потребителям создавать, эксплуатировать и/или ремонтировать инструменты, устройства, программное и аппаратное обеспечение.
техническая документация
• , включающая руководства по ремонту, руководства по техническому обслуживанию и технические спецификации; официальные документы, исследовательские работы или журнальные статьи; справочники; и годовые отчеты.
• маркетинговые копии, такие как рекламные объявления, брошюры, каталоги, пресс-релизы и содержимое домашней страницы.

Техническое написание осуществляется в соответствии с различными соображениями:

• Формат: Будет ли он опубликован в печати или в Интернете? Будет ли автор отправлять необработанный текст для последующего форматирования или он также несет ответственность за его представление?
• Источник: будет ли автор получать информацию от одного или нескольких людей, обладающих соответствующими знаниями (часто называемых экспертами в предметной области), из предоставленных печатных или онлайн-ресурсов, из материалов, которые автор должен будет идентифицировать и найти, или из комбинации источники?
• Аудитория: Каковы технические возможности читателей? Являются ли читатели непрофессионалами, людьми, знакомыми с темой, но не разбирающимися в ней, или экспертами?

Ожидаемый формат определяет, должен ли писатель также быть информационным дизайнером, источник(и) определяют, нужны ли писателю навыки проведения интервью и/или исследования, а также навыки письма, а аудитория определяет, будет ли и в какой степени автор должен определить или пересмотреть технические термины и/или упростить описания и пояснения.

Технические писатели, конечно же, должны уметь объяснять иногда сложные процедуры понятным языком. Им также полезно знать принципы учебного дизайна и уметь создавать и представлять визуальные и звуковые материалы для дополнения или замены письменного содержания. Кроме того, технических писателей часто просят создать более одной версии документа для пользователей с разным уровнем знаний.

Но наиболее важными навыками для технических писателей являются решение проблем и устранение неполадок, потому что те, кто создает документацию, находятся в лучшем положении, чтобы замечать и реагировать на препятствия и несоответствия в ее производстве; подобно любому писателю или редактору, технический писатель является представителем читателя, изучая документацию с точки зрения пользователя и следя за тем, чтобы она предвосхищала любые вопросы или опасения, которые у них могут возникнуть.

Спектр профессиональных дисциплин, в которых ведется техническое письмо, разнообразен.