Большая часть необходимой технической информации, которую люди знают сегодня, обычно загружается с компьютерным программным обеспечением, различными инструментами и электронными устройствами. Техническая коммуникация жизненно важна для обмена информацией и помощи пользователям лучше понять технологию или продукт. Требуется время, чтобы придумать техническая информация и дополнительное время для перевода контента.
Производители делятся своими знаниями через техническая документация.
Определение технической документации
Как уже упоминалось, производители создают техническую документацию, чтобы помочь конечным пользователям понять архитектуру и динамику работы гаджета или продуктов, которые они используют. Это подробное описание продукции и еще один инструкция о том, как использовать предмет.
Части технического документа
Части технического документа различаются в зависимости от самого документа и его цели. В широком смысле, практический документ состоит из трёх существенных частей:
- Содержание
- Актуальные инструкции
- Указатель или глоссарий
Элементы технического документа
Каждый основной компонент состоит из множества подкомпонентов, поэтому для написания технической документации требуется эксперт.
1. Передняя крышка
- Название
- Номер документа
- Версия документа
- Название продукта
- Версия продукта
- Дата выпуска документа
- Заявление об авторских правах, дата и другой текст, относящийся к интеллектуальной собственности.
- Изображение или графика продукта
- Корпоративный логотип
- Заявление о товарных знаках для различных брендов, упомянутых в техническом документе.
- Информация о компании, контактные телефоны, URL-адрес веб-сайта и т. д.
- Тексты об отказе от ответственности и раскрытии информации
Примечание. Вы не добавляете номер страницы на обложку.
2. Содержание
При подготовке оглавления (TOC) вы обычно начинаете с номера страницы строчными буквами. Обычно вы начинаете с «iii» или римской цифры «3», поскольку передняя обложка обычно занимает две страницы.
Далее, приходите Названия глав и номера страниц. Сделайте отступы в заголовках разделов и номерах страниц. Также сделайте отступы для подразделов. Все записи в оглавлении должны иметь номер страницы, на которой пользователь может найти конкретную информацию.
После названий укажите список рисунков и номера страниц, домен список таблиц и номера страниц, другие списки (например, авторы), за которым следует Глоссарий, дополнение, приложениекачества индексные заголовки.
Ассоциация Глоссарий обычно состоит из двух столбцов для элемента и описания и содержит технические термины, сокращения и акронимы, включенные в контент.
3. Задняя крышка
Задняя крышка содержит корпоративный логотипВсе корпоративная контактная информация, и заявление об авторских правах и даты.
10 советов, как улучшить навыки технического письма
Исследователи и инженеры обычно создают техническую документацию. Они должны обладать навыками общения, чтобы пользователи могли понять, что они хотят сообщить. Но зачастую у них нет навыков письма для создания технической документации, которую конечные пользователи обязательно оценят, поскольку уровень их понимания различается.
Если вы специализируетесь на написании технических статей, у вас есть навыки создания функциональных документов, а также высокий уровень технических знаний и понимания, а также последовательная, краткая и ясная манера выражения информации.
Вот несколько советов о том, как улучшить свои навыки технического письма.
- Подумайте о целевой аудитории
Техническое письмо имеет определенную аудиторию. Вам следует подумать, кто они и что им нужно знать и делать. Предоставьте читателю набор логических шагов и объясните, что ему нужно делать на каждом этапе.
- Знать продукт изнутри и снаружи
Вы должны досконально знать продукт, чтобы иметь возможность делиться сложными идеями и концепциями простыми словами. Получите всю информацию от клиента, проведите дополнительные исследования, проконсультируйтесь со специалистами и прочитайте сопутствующую информацию. Делайте это до тех пор, пока не почувствуете, что готовы объяснить содержание точно, но на понятном языке.
- Подумайте о правильной структуре
Создайте логическую структуру подачи информации. Подумайте, что нужно делать пользователям, если они столкнутся с проблемой. Подумайте обо всех вещах, которые могут пойти не так, и дайте им точное объяснение. Убедитесь, что идеи текут свободно и естественно. Используйте переходы, если разделов несколько, чтобы улучшить читабельность.
- Правильно оформляйте текст
Правильная компоновка облегчает навигацию по тексту. Правильная раскладка делает текст более понятным. Помните, что некоторые читатели просматривают документ и выделяют важные моменты, которые им нужны, в то время как другие хотят прочитать все содержимое.
- Добавить иллюстрации
Иллюстрации способны разбавить монотонность чтения непрерывного потока текста. Иллюстрации могут понадобиться для идентификации частей товара, например, ноутбука. Вы можете использовать диаграммы, фотографии, иллюстрации, диаграммы и таблицы. Но используйте их экономно и убедитесь, что пользователи могут ссылаться на них при чтении связанного текста.
- Приведите примеры
Примеры связывают имеющуюся у вас информацию с реальностью, превращая идеи в практические дела. Добавление визуальных эффектов может помочь объяснить различные ситуации.
- Улучшите возможности поиска
Убедитесь, что читатель может легко найти соответствующую информацию, используя оглавление или указатель. TOC — это дорожная карта для всего документа. Индекс также полезен при поиске конкретной информации.
- Общайтесь с читателями
Ваш текст будут использовать люди, поэтому используйте разговорный стиль. Пишите от второго лица, что также облегчает чтение текста. Используйте активный залог и настоящее время как можно чаще. Помните, что читатели будут иметь разные уровни понимания, поэтому целесообразно сделать текст доступным.
- Прочтите и пересмотрите
Даже если вы эксперт в предметной области, всегда читайте и редактируйте свой текст. Использование редактора и корректора поможет протестировать документ и найти в нем ошибки перед отправкой.
- Получать отзывы
Обратная связь поможет улучшить ваши навыки технического письма. Вы узнаете, полезен ли ваш документ, понимают ли они сообщение или находят ли их вопросы ответы из вашего текста. Конструктивная критика и отрицательные отзывы дадут вам возможность улучшить свои навыки письма, поскольку другие люди смогут увидеть ошибки и другие ненужные шаблоны письма, которые вы не можете увидеть сами.
Вам нужна помощь в переводе технической документации?
Техническая документация нуждается в предметной экспертизе, и Служба электронных переводов может легко предоставить вам эксперта. Наши переводчики являются носителями языка и имеют многолетний опыт работы, необходимый для перевода технической документации на более чем 200 языков. Вы можете написать нам по адресу [email protected]etranslationservices.com или позвоните нам по телефону (800) 882-6058, чтобы получить ценовое предложение без каких-либо обязательств или дополнительную информацию сегодня.
