7 советов по техническому письму, без которых вы не сможете жить
Традиционно техническое письмо определялось как практика документирования процессов, написания инструкций и т. д. Но поскольку мы вступаем во все более зависимое от технологий общество, это определение уже не имеет смысла.
Технические писатели охватывают широкий спектр отраслей: от биотехнологий и фармацевтики до инжиниринга, ИТ, финансовых услуг, управления цепочками поставок и некоммерческого сектора. И они не ограничиваются README и руководствами.
В наши дни технический писатель пишет отчеты, руководства, пресс-релизы, официальные документы, тематические исследования, предложения, тексты веб-сайтов и многое другое.
Учитывая это, становится ясно, что техническое письмо — это важный деловой навык. Вот семь советов по техническому письму, которые помогут вам привнести больше опыта в игру.
1. Главный совет по написанию технических текстов: переходите к сути
Если копирайтинг — это убеждение, то название игры в техническое письмо — понимание. В идеальном мире вы создаете тему, которую читатель понимает сразу. Вы не хотите, чтобы они читали текст, пытаясь понять, что делать дальше.
Технические статьи часто могут быть длинными, поскольку в небольшом объеме сосредоточено много информации.
Удалите излишне длинные фразы, подобные следующим:
- В настоящее время
- Круг вокруг
- Бесплатный подарок
- Никогда раньше
- Все еще сохраняется
- 2 часа ночи
- Квадратной формы
- 12 полночь
- И т. д.
Существует бесчисленное множество шаблонных фраз, подобных тем, что используются в предыдущем разделе, а также те, которые мы используем для связи наших предложений. Такие вещи, как «с другой стороны», можно заменить простым «однако».
Для получения дополнительной информации о том, как быстро перейти к сути, ознакомьтесь с этой статьей Элементы стиля Уильяма СтранкаЧасть информации немного устарела (опубликована в 1918 году), но она представляет большую ценность для начинающих технических писателей.
2. Используйте простой язык для хорошего технического письма
Просто — не значит глупо. Многие начинающие технические писатели считают, что наполнение статьи отраслевым жаргоном и корпоративными модными словечками — ключ к тому, чтобы звучать умно. Но тема и без них достаточно сложна.
Сделайте текст коротким и цепляющим, урезав грамматику и словарный запас. Думайте о ясной, лаконичной коммуникации. Если цель или контекст нелегко понять, вы не общаетесь эффективно.
Сократите предложения, убрав как можно больше знаков препинания и используя меньше слов. В идеале вам не придется использовать много запятых и точек с запятой в своем тексте. Но вы увидите больше точек.
Кроме того, вы не хотите использовать более длинные слова, когда их более короткие собратья подойдут. Подумайте use вместо use, feature вместо functional.
3. Помните, что ваши читатели не такие эксперты, как вы
Одна из самых больших ошибок, которую может совершить технический писатель, — это предположить, что читатель уже имеет определенный уровень знаний, прежде чем использовать рассматриваемое решение. Таким образом, он в конечном итоге пропускает объяснения или начальные инструкции.
То, что ваше решение имеет наибольший смысл для продвинутых веб-разработчиков, не означает, что кто-то за пределами этой группы не найдет контент полезным. Вместо этого потратьте немного времени и создайте персоны покупателей на основе вашей целевой аудитории.
4. Попросите друга прочитать ваше письмо
Получите обратную связь из нескольких разных источников. В идеале вам нужно будет оценить, сможет ли человек с небольшим знанием предмета понять концепции в статье. С другой стороны, покажите свое письмо кому-то с большим опытом, чем у вас.
Идея в том, что вы создаете что-то точное и информативное, независимо от того, какими знаниями они обладают.
5. Подумайте, как вы обращаетесь к аудитории
При использовании формального технического письма использование первого лица считается дурным тоном. Это может меняться в зависимости от вашего приложения — подумайте о веб-сайтах с неформальным тоном или о вводном тексте для нового мобильного приложения. Но главное — обратиться к аудитории напрямую.
Во-вторых, хотя это может не соответствовать вашему представлению о совете по техническому письму, лучше всего использовать гендерно-нейтральный язык. Указание пола по умолчанию может вызвать у некоторых читателей чувство отчуждения.
6. Поиграйте с макетом
Как и контент-маркетинг и копирайтинг, техническое письмо работает лучше всего, когда вы рассматриваете визуальный подход. Под визуальным подходом мы подразумеваем то, как вы организуете композицию.
Использовать иерархия заголовков для сообщения ваших идей на основе важности. Хотя это считается SEO-дружественной практикой, это также облегчает читателям поиск информации, необходимой для изучения вашего решения.
Самый важный заголовок — H1, ваша главная идея. Подзаголовки (H2) обозначают важные моменты, а H3 и ниже представляют идеи внутри этих подзаголовков.
Теперь, если вы создаете письменное руководство, система ранжирования Google может не представлять особой проблемы. Но это простой способ начать с плана представления этих больших, сложных тем.
Помимо заголовков и подзаголовков, технический текст может выиграть от стратегического использования маркеров. Маркеры помогают разбить страницу и облегчить читателям просмотр списка.
Уинворд Инжиниринг хороший пример использования иерархии заголовков и маркеров, если вам нужна наглядность.
7. Не будьте пассивны в написании технических текстов
Этот последний совет по техническому письму посвящен использованию действительного залога.
Глаголы могут быть сложными, даже для писателей с некоторым опытом за плечами. Вы можете взять глаголы действия и преобразовать их во что-то, что предполагает пассивность.
Суть технического письма — донести свою точку зрения как можно быстрее и яснее. Переставляя предложения (например, «Джон пнул мяч» вместо «Мяч был пнут Джоном»), вы добавляете слова и запутываете сообщение.
Тем не менее, иногда есть нет способа обойти пассивный залогособенно если субъект не предпринимает никаких активных действий.
Помимо технических советов по письму — научитесь оттачивать свое писательское мастерство
В конце концов, мы надеемся, что этот краткий список советов по техническому письму будет полезен. Техническое письмо отличается от написания эссе или копирайтинга, но это важное ремесло само по себе. Каждый может извлечь пользу из постоянной практики, проверки работы и получения постоянной обратной связи.
Хотите узнать больше о написании отличного контента? Посетите Article City, чтобы узнать больше о том, как извлечь максимум пользы из своей писательской карьеры.