Техническое письмо сообщает читателям техническую информацию о навыке или продукте. Он широко используется в технических и профессиональных областях. Как технический писатель, вы часто пишете такие документы, как руководства пользователя, документация по интерфейсу прикладного программирования (API), а также руководства по ремонту и продуктам.
Как и в других нишах писательского мастерства, в техническом письме есть свои правила. Следование этим рекомендациям поможет вам писать хорошо структурированные документы и оптимизировать то, как читатели понимают вашу работу. Вот несколько правил, которым нужно следовать, чтобы стать хорошим техническим писателем.
1. Определите свою аудиторию
Анализ аудитории — обязательный фактор хорошего технического документа. Знание своей аудитории поможет вам определить, о какой информации писать, как ее структурировать и какие особенности использовать. Есть четыре основных аудитории для технического письма: руководители, эксперты, техники и неспециалисты.
Руководители — это люди, которые финансируют продукт и принимают политические, административные и экономические решения, которые его определяют. Техники — это люди, которые строят, эксплуатируют и ремонтируют эти продукты. Эксперты разрабатывают, тестируют и знают все о продукте, а неспециалисты являются конечными пользователями продуктов. Вы должны учитывать свою аудиторию, чтобы определить лучший тон и стиль письма для использования.
2. Определите потребности вашей аудитории
Помимо знания и определения вашей аудитории, крайне важно, чтобы вы понимали их цели, интересы и потребности. Завершение анализа аудитории является ключевым моментом в подготовке документа, так как вы с меньшей вероятностью будете писать без ошибок и хорошо знаете потребности своей аудитории.
Чтобы провести всесторонний анализ аудитории, вы должны учитывать предысторию вашей аудитории, существующие знания о продукт, опыт, потребности, интересы, демографические характеристики, культура и коммуникативные предпочтения, а также цели. Эта информация поможет вам наиболее эффективно и действенно представить свои идеи.
3. Знайте пределы знаний вашей аудитории
В качестве метода анализа аудитории вы можете использовать опросы и анкеты, чтобы узнать пределы знаний вашей аудитории. Вы также можете получить популярные мнения и стереотипы, личный опыт, мозговой штурм и отзывы аудитории в отделе маркетинга.
Если вы правильно используете вышеперечисленные инструменты, вы будете знать, насколько ваша целевая аудитория понимает информацию, которую вы собираетесь донести. Эта информация во многом определит структуру, ограничения и объем вашего документа, давая вам представление о направлении.
4. Держите свой язык простым
Техническое письмо должно представлять слишком сложную тему. Это делается с помощью простого руководства по стилю письма. Вы должны убедиться, что средний читатель может легко понять ваш текст.
Тем не менее, вы должны отметить, что понимание вашей аудитории также является ключом к выбранному вами языковому стилю. Например, профессиональный жаргон в документе о интерфейсы прикладного программирования (API) может подходить для технических специалистов, но не для конечных пользователей. Следовательно, вы должны использовать простой для понимания язык, чтобы облегчить понимание аудитории. Вы также можете узнать как использовать такой инструмент, как Microsoft Editor чтобы проверить свою работу и убедиться, что письмо на месте.
5. Использовать контуры
Планы дают вашим читателям представление о том, чего ожидать от документа. Документ без схемы ошеломляет читателей, поскольку заставляет их читать весь текст, когда они заинтересованы только в получении конкретных знаний.
Как техническому писателю, схема вашего документа также дает вам чувство направления при написании. Это держит вас в курсе и гарантирует, что вы не пропустите или недооцените важные моменты. Кроме того, это улучшает структуру вашего документа и служит обратной связью о том, что вы собираетесь охватить.
6. Используйте графику там, где это необходимо
Внимание большинства читателей, естественно, привлекает графика, а не текст. В технических документах подходящая графика может улучшить понимание текста читателями за счет четкого и выразительного представления информации.
Однако, как технический писатель, вы должны быть осторожны, чтобы не использовать графику для украшения документов. Таблицы, графики, диаграммы, фотографии и иллюстрации являются широко используемой графикой, и они могут улучшить общую структуру документа и привлечь внимание читателей. Тем не менее, если вы новичок в Google Docs, вот как создавать и редактировать таблицы в Google Docs.
7. Привлекайте своих читателей
Хотя вы, возможно, пытаетесь передать техническую информацию своим читателям, важно, чтобы вы также привлекали их. Каждый технический документ ориентирован на читателя и должен быть написан по вкусу читателя, а не автора. Интеллектуальное любопытство вашего читателя должно быть удовлетворено, чтобы ваш документ был полезным.
Вы можете активно вовлечь своего читателя, написав, чтобы выразить, а не произвести впечатление, и сразу перейти к делу. Избегайте сокращений и жаргона, используйте много пустого пространства для улучшения визуального представления и используйте заголовки, чтобы направить читателя.
8. Не ссылайтесь на срочную информацию
Всегда предпочтительнее избегать ссылок на срочную информацию, особенно за сопоставимый период. Безопаснее и разумнее использовать анализ, выдержавший испытание временем, что делает его вечно актуальным и всегда подходящим для тех, кто будет читать ваш документ в будущем.
Вы также должны учитывать, что добавление конкретных лет, например «2019», чтобы подчеркнуть вашу точку зрения, может со временем снизить полезность вашего документа, за исключением особых случаев. Вы можете предотвратить это, используя более широкие временные рамки, такие как «За последние семь лет», таким образом, придавая вашей работе определенный уровень доверия.
9. Используйте соответствующие примеры
При написании технического документа используйте живые экземпляры, чтобы подчеркнуть свою точку зрения. Поскольку ваша аудитория читает ваше письмо, чтобы приобрести навык, решить проблему или изучить некоторые рекомендации, вы должны предоставить им практические и подходящие примеры.
Эти примеры повышают удобочитаемость вашей работы и сообщают читателю сложную информацию, обеспечивая контекст для продуктов и процессов. Таким образом, они с большей вероятностью будут использовать продукты преднамеренно и безопасно.
10. Получите стороннюю проверку перед публикацией
Технический документ всегда должен проходить совместный процесс, в котором участвуют автор и рецензент. Независимая проверка помогает создать ориентированный на аудиторию, безошибочный и эффективный документ.
Как первоначальный автор документа, вы, возможно, написали много черновиков, прежде чем создать окончательный документ. Тем не менее, каким бы хорошим ни казался ваш документ, не полагайтесь только на свой ум.
Станьте профессиональным техническим писателем сегодня
Понимание основных правил технического письма сделает вас более опытным и востребованным. Многие организации знают, насколько важно, чтобы их продукты или услуги хорошо рекламировались конечным пользователям, и помочь им в этом — ваша цель как технического писателя.
