Вы писатель, рассматривающий возможность перехода к прибыльным карьерным возможностям, доступным в области технического письма? Если это так, время, потраченное на изучение ремесла, имеет решающее значение для вашего успеха. Эти советы по техническому письму могут стать хорошей отправной точкой.
Успех технического письма
Вот несколько технических советов по письму, которые вы можете применить, чтобы немедленно повлиять на свои навыки письма.
1. Найдите хороших экспертов
В некоторых случаях вы можете быть своим собственным экспертом. Писатели также могут быть экспертами в предметной области (SME), которые пишут технические руководства для программного обеспечения или технологий, которые они создали. Однако в большинстве случаев ваш опыт обычно не связан с оборудованием или темой, о которой вы пишете; скорее письмо — это ваш опыт. Поэтому присоединяйтесь к качественным экспертам в области, на которую вы ориентируетесь.
Включите их мозги, изучите их жаргон и узнайте о продукте или услуге, о которых вы пишете, насколько это возможно. Есть большая вероятность, что вы никогда не накопите знания, которыми обладают эти эксперты в своей области, поэтому используйте их в своих интересах. Ваше письмо будет звучать более правдоподобно, если оно будет звучать так, как будто вы эксперт (даже если вы им не являетесь).
2. Проведите исследование
Если вам нужно провести исследование, найдите оригинальную документацию или исследование. Использование вторичных и третичных источников означает, что вероятность неправильной интерпретации данных или информации увеличивается, и вы можете случайно изменить значение или предоставить неверную информацию из-за неправильной интерпретации кем-то другим. Всегда обращайтесь к оригиналу. Это стоит времени и усилий.
3. Планируйте и организуйте
Прежде чем приступить к проекту, вы должны составить план и организовать себя. На этапе планирования проекта вы должны собрать всю относительную информацию, которую вы можете найти по вашей теме. Это может включать любые спецификации, описания, стандарты, варианты использования и многое другое. У вас также должно быть очень четкое представление о том, что вы должны создать, будь то технический документ, руководство пользователя, руководство по установке или что-то еще, и понимать, в каком качестве клиент хочет, чтобы это было доставлено (по электронной почте, на компакт-диске или в бумажном виде). ).
Скорее всего, у вас будет много информации, поэтому организуйте ее таким образом, чтобы вы могли легко найти то, что вам нужно, когда вам это нужно. Планируя и организуя, вы сокращаете свою рабочую нагрузку еще до того, как начнете писать.
4. Потеряйте свой стиль
В технической письменной форме все дело в том, чтобы быть понятым как можно большим количеством людей. Вы не хотите иметь личный стиль письма для технического письма; стиль отлично подходит для художественной и личной документальной литературы, такой как эссе, но в техническом письме вам нужен простой, легкий для понимания научный тон, который не передает вашу личность или личность. Технический текст должен звучать одинаково, независимо от того, кто его написал.
5. Будьте ясны и лаконичны
Техническое письмо должно быть ясным и кратким. Используйте как можно меньше слов, чтобы максимально четко передать то, о чем вы пишете. Короткие простые предложения подойдут. Вам не нужно писать длинные и сложные предложения, чтобы передать простые идеи. Вы также хотите избежать избыточности. Редактирование поможет вам избежать лишнего.
6. Пишите официально
Академическое письмо и техническое письмо имеют некоторые общие черты. Избегайте сокращений, не начинайте предложения со слабых начал (например, «было» и «это») и избегайте использования слишком большого количества знаков препинания, которые не нужны. Точки, запятые и другие основные необходимые знаки препинания допустимы, но будьте осторожны с использованием точек с запятой, двоеточий и дефисов. Еще одно сходство — точка зрения. В техническом письме вы должны использовать только третье лицо. Не используйте точку зрения от первого или второго лица.
7. Цитирование — ваш друг
При использовании этих внешних источников и экспертов убедитесь, что вы правильно цитируете их в своем письме и в конце текста. Метод цитирования будет варьироваться в зависимости от того, для кого или для чего вы пишете, но помните, что плагиат есть плагиат, независимо от того, предназначен ли он для класса или для компании. Если вы не написали это изначально, процитируйте.
8. Будьте последовательны
Последовательность является ключевым фактором. Независимо от того, как вы ссылаетесь на таблицу или график или как вы ссылаетесь на другой раздел руководства или руководства, всегда делайте это одинаково. Если вы делаете заглавной первую букву каждого слова в названии раздела, то всегда делайте это именно так. Если вы говорите: «См. Таблицу 1.1», тогда следует также сказать: «См. График 1.2». Если в используемом вами формате есть правило, следуйте ему. Если нет, убедитесь, что ваша работа по-прежнему соответствует руководству по стилю, даже если она создана вами.
9. Используйте пустое пространство
Не только художники-графики должны думать о том, как что-то выглядит. Ваша работа как технического писателя состоит в том, чтобы сделать документ читабельным. Вспомните классическую художественную литературу, в которой предложения и абзацы занимают целую страницу. Они плотные и в них трудно ориентироваться, а отсутствие пустого пространства затрудняет отслеживание. Использование заголовков, подзаголовков, таблиц и графиков позволяет использовать пробелы, которые позволяют читателям легче просматривать документ.
10. Сосредоточьтесь на задачах
Все, что вы пишете, состоит из частей. Это могут быть физические части, например газонокосилки, или этапы, например использование программного обеспечения или установка оборудования на компьютер. Разбейте эти части и шаги на группы по семь или девять. Люди могут справиться с семью или девятью частями и запомнить их; больше частей, чем это, и ваш читатель может запутаться или забыть. Не позволяйте вашим читателям терять из виду то, что они — и вы — делаете. Разбейте вещи на отдельные части, а затем сгруппируйте их.
Практика, практика, практика
Техническое письмо — одна из наиболее дисциплинированных форм профессионального письма, потому что писатель не может передать свои мысли, мнения или эмоциональные чувства тексту. В технической письменной форме все дело в фактах. Узнайте, как освоить эти советы по техническому письму, и, прежде чем вы это узнаете, вы будете пользоваться большим спросом и зарабатывать хорошие деньги, написав специализированные тексты для технической отрасли.