9 советов по техническому письму, которые помогут улучшить ваши навыки
Даже если вы работаете в технологически ориентированной области, написание все равно является важной частью работы. Вероятно, придет время, когда вам понадобится написать техническую документацию — будь то анализ сайта, инструкция или что-то подобное.
Независимо от того, являетесь ли вы опытным писателем или все еще пытаетесь выяснить, в чем заключаются ваши сильные стороны в писательстве, всегда есть место для совершенствования. Прочтите девять советов по техническому письму, которые помогут вам улучшить навыки технического письма.
1. Включите свою личность
Когда большинство людей думают о техническом письме, они автоматически думают, что это означает, что их стиль должен быть академическим и отстраненным. На самом деле, все наоборот.
Хорошее техническое письмо имеет элемент индивидуальности, который помогает людям продолжать читать то, что вы написали. Это не значит, что вы должны сделать его суперразговорным, но вы также не пишете статью AP.
Вы хотите звучать одновременно и по-человечески, и профессионально, а не как машина, просто выплевывающая слова.
2. Не думайте, что ваш читатель все знает
Это распространенная проблема в техническом письме. Автор предполагает, что поскольку читатель уже наткнулся на его документ, у него автоматически есть некоторые базовые знания по теме.
Это может быть правдой, но никогда не стоит делать предположений. Вы можете потерять читателей, если они слишком запутаются или почувствуют, что документ был написан не для них.
Например, кто-то из Общественные компьютерные услуги Вероятно, он знает основы удаления вредоносных программ. Чего нельзя сказать о человеке, который дома пытается найти совет, как избавиться от вируса.
Вы хотите убедиться, что оба человека в приведенном выше сценарии смогут понять ваш текст и решить любые возникающие у них проблемы.
Если то, что вы пишете, предназначено для определенной аудитории — например, для команды в вашей компании — то вы можете смело предполагать наличие определенных знаний. Если же нет, то лучше включить справочную информацию или инструкции, когда это необходимо.
3. Меньше значит больше
Когда вы думаете о технической документации, вы представляете себе скучный, бесконечный документ? Если да, то похоже ли то, что вы себе представили, на то, что вам хотелось бы прочитать?
Вероятно, нет.
Вам не нужно использовать много слов, чтобы донести свою точку зрения. Вместо этого вы должны стремиться объяснить себя в наименьшем количестве слов. Краткость поможет вам в написании и облегчит понимание читателем.
4. Сохраняйте простоту
ВМС США придумал термин в 1960 году, чтобы описать свой идеальный принцип дизайна. Их аббревиатура KISS означает Keep It Simple, Stupid.
Вы также можете применить этот принцип к дизайну всего, что вы пишете. Используйте понятный и по существу язык, вместо того, чтобы чувствовать, что вам нужно использовать много жаргона или четырехсложных слов.
Если есть более простой способ донести свою точку зрения, воспользуйтесь им.
Это имеет дополнительный бонус: ваш документ будет понятен даже тем людям, для которых английский язык не является родным.
5. Ориентируйтесь на задачу
Как еще можно убедиться, что ваш текст понятен и прост для восприятия?
Один из способов сделать это — сосредоточиться на задачах, которые должен выполнить читатель. Это особенно важно, если вы создаете технические инструкции.
Полезно, если вы уже сделали анализ задачи, прежде чем начали писать. Таким образом, вы точно знаете, что вам нужно объяснить, и можете создать план на основе своей предыдущей работы.
Вам следует избегать обдумывания вещей во время написания, поскольку это может привести к созданию слишком запутанных или многословных инструкций.
6. Используйте мультимедиа
Не бойтесь использовать мультимедиа в своих текстах. Недаром говорят: «Картинка стоит тысячи слов».
Используйте фотографии для иллюстрации своей точки зрения, особенно если это помогает читателю понять концепцию, которую вы бы долго объясняли текстом. Вы даже можете использовать такие вещи, как GIF-файлы или видео, если вы действительно хотите поднять ее на новый уровень.
Включите медиа, которые имеют смысл для того, что вы пишете. Если вам специально не сказали создать только текстовый документ, нет причин этого не делать.
7. Отформатируйте свой текст
Так же, как ваше техническое письмо не должно быть только текстом, оно также не должно быть огромными блоками текста. Форматирование вашего письма облегчает его чтение.
Вместо того, чтобы писать большие абзацы, начинайте новый абзац каждые два-три предложения. Дополнительное пустое пространство облегчает чтение, особенно на экране компьютера или телефона.
Вы можете использовать разрывы строк, жирный шрифт и маркеры, чтобы привлечь внимание читателей к тому месту, куда вы хотите, чтобы они попали.
8. Используйте ссылки
Не все должно быть объяснено прямо в документе, с которым вы работаете. Иногда вместо этого можно использовать атрибуции или ссылки, чтобы направить людей в правильном направлении.
Это отличный совет, если вы пишете для широкой аудитории и не уверены, сколько информации у них уже есть. Включение ссылок на другие документы гарантирует, что люди, которым нужна дополнительная информация, смогут ее найти.
Однако если другой читатель уже знаком с основами, он может продолжить чтение, не упуская ни одной детали.
9. Помните о своих целях
Наконец, наш последний совет для создания отличного технического текста — всегда помните о своих целях.
Иногда, когда пишешь, понимаешь, что можно было бы включить гораздо больше. Когда пытаешься включить всю эту информацию, документ из 1000 слов внезапно превращается в документ из 2000.
Знание своих целей заранее поможет вам сосредоточиться только на самой важной информации. Некоторые дополнительные детали хороши, но их слишком много, и ваш документ будет трудно прочитать.
Если вы действительно считаете, что эта информация важна, воспользуйтесь советом номер восемь выше и включите вместо этого несколько ссылок.
Найдите больше советов по написанию технических текстов
С этими девятью советами по техническому письму как новички, так и эксперты могут улучшить свое техническое письмо. Независимо от того, какая у вас задача, вы сможете общаться четко и лаконично.
Нужны еще советы? Продолжайте изучать, как писать техническую документацию, в статьях нашего блога. Ознакомьтесь с нашими советами по написанию прямо здесь.