Техническое письмо - это написание или подготовка технического сообщения, используемого в технических и профессиональных областях, таких как компьютерное оборудование и программное обеспечение, инженерия, химия, аэронавтика, робототехника, финансы, медицина, бытовая электроника, биотехнология и лесное хозяйство. Техническое письмо охватывает крупнейшее подразделение технической коммуникации.
Общество технической коммуникации определяет техническую коммуникацию как любую форму коммуникации, которая демонстрирует одно или несколько из следующие характеристики: «(1) общение на технические или специализированные темы, такие как компьютерные приложения, медицинские процедуры или экологические нормы; (2) общение с использованием технологий, таких как веб-страницы, файлы справки или сайты социальных сетей; или (3) с инструкциями о том, как что-то делать, независимо от того, насколько технически задача ».
Содержание
- 1 Обзор
- 2 История
- 3 Методы
- 4 Технические документы
- 5 Инструменты
- 6 Список ассоциаций
- 7 Ссылки
- 8 Внешние ссылки
Обзор
Техническое написание выполняется техническим писателем (или техническим автором) и является процессом написание и обмен технической информацией в профессиональной среде. Основная задача технического писателя - передать техническую информацию другому лицу или стороне самым ясным и эффективным способом. Информация, которую сообщают технические писатели, часто бывает сложной, поэтому необходимы хорошие навыки письма и общения. Они не только передают информацию посредством текста, они также должны хорошо владеть компьютером. Технические писатели используют широкий спектр программ для создания и редактирования иллюстраций, программ построения диаграмм для создания наглядных пособий и процессоров документов для проектирования, создания и форматирования документов.
Хотя техническая документация обычно ассоциируется с интерактивной справкой и руководствами пользователя, термин техническая документация может охватывать более широкий диапазон жанров и технологий. Пресс-релизы, служебные записки, отчеты, бизнес-предложения, таблицы данных, описания продуктов и спецификации, официальные документы, резюме и заявления о приеме на работу - это всего лишь несколько примеров написания, которые можно рассматривать как техническую документацию. Некоторые типы технической документации обычно не обрабатываются техническими писателями. Например, пресс-релиз обычно пишется писателем по связям с общественностью, хотя технический писатель может вносить свой вклад в любую техническую информацию, включенную в пресс-релиз.
История
Хотя техническое письмо было признано профессией только после Второй мировой войны, его корни уходят в античность. Критики ссылаются на работы таких писателей, как Аристотель, как на самые ранние формы технического письма. Работа Джеффри Чосера «Трактат об астролябии» является ранним примером технического документа и считается первым техническим документом, опубликованным на английском языке.
С изобретением механического печатного станка, наступлением Возрождения и подъемом Возраст разума, документирование находок стало необходимостью. Изобретатели и ученые, такие как Исаак Ньютон и Леонардо да Винчи, подготовили документы, в которых описывались их изобретения и открытия. Хотя эти документы никогда не назывались техническими документами в период их публикации, эти документы сыграли решающую роль в развитии современных форм технической коммуникации и письма.
Область технической коммуникации расширилась во время промышленной революции. Возникла потребность в предоставлении людям инструкций по использованию изобретаемых все более сложных машин. Однако, в отличие от прошлого, когда навыки передавались через устные традиции, никто, кроме изобретателей, не знал, как использовать эти новые устройства. Таким образом, письмо стало самым быстрым и эффективным способом распространения информации, и писатели, которые могли документировать эти устройства, были желательны.
В течение 20 века потребность в техническом письме резко возросла, и эта профессия, наконец, получила официальное признание. События Первой мировой войны и Второй мировой войны привели к достижениям в медицине, военном оборудовании, компьютерных технологиях и аэрокосмических технологиях. Этот быстрый рост в сочетании с острой войной вызвал немедленную потребность в хорошо разработанных и письменных документах, в которых описывалось использование этих технологий. Техническое письмо было очень востребовано в то время, и «технический писатель» стал официальным названием должности во время Второй мировой войны.
После Второй мировой войны технический прогресс привел к увеличению количества потребительских товаров. и уровень жизни. Во время послевоенного бума государственные службы, такие как библиотеки и университеты, а также транспортные системы, такие как автобусы и шоссе, пережили огромный рост. Потребность писателей в записи этих процессов возрастала. Именно в этот период компьютеры начали использоваться в крупных компаниях и университетах. Примечательно, что в 1949 году Джозеф Д. Чаплин создал первый вычислительный технический документ, руководство для компьютера BINAC.
Открытие транзистора в 1947 году позволило компьютеры будут производиться дешевле, чем когда-либо прежде. Эти сниженные цены означали, что компьютеры теперь могли приобретать частные лица и малые предприятия. И в результате растущей известности компьютеров выросла потребность в писателях, которые могли бы объяснить и задокументировать эти устройства. Профессия технического писателя продолжала расширяться в 1970-х и 1980-х годах, поскольку бытовая электроника находила все больше и больше людей в домах.
В последние годы популярность компьютеров в обществе привела ко многим достижениям в области цифровых коммуникаций, что привело к изменениям в инструментах, которые используют технические писатели. Гипертекст, текстовые процессоры, программы редактирования графики и программное обеспечение для верстки страниц сделали создавать технические документы быстрее и проще, чем когда-либо прежде, и современные технические писатели должны хорошо владеть этими программами.
Методы
Хороший технический текст должен быть кратким, целенаправленным, легким для понимания, свободным от ошибки, и на основе аудитории. Технические писатели стараются сделать свои документы как можно более ясными, избегая излишне технических фраз и стилистических предпочтений, таких как пассивный залог и номиналов. Поскольку технические документы используются в реальных ситуациях, они должны всегда четко понимать, что является предметом технического документа и как использовать представленную информацию. Было бы катастрофой, если бы, например, инструкции технического писателя о том, как пользоваться мощным рентгеновским аппаратом, было трудно расшифровать.
Написание технических работ требует от писателя тщательного изучения своей аудитории. Технический писатель должен быть осведомлен об имеющихся у своей аудитории знаниях о материале, который они обсуждают, поскольку база знаний писательской аудитории определяет содержание и направленность документа. Например, отчет об оценке, в котором обсуждаются результаты научного исследования, который написан группе высококвалифицированных ученых, будет составлен совершенно иначе, чем отчет, предназначенный для широкой публики. Технические писатели не обязательно должны быть профильными экспертами (МСБ). Они часто сотрудничают с МСП для выполнения задач, требующих большего знания предмета, чем они обладают.
Техническое описание должно быть точным. Технический писатель, проанализировав свою аудиторию, знает, что им нужно сообщить, а затем должен передать сообщение точным и этичным образом. Если автор сделает это неправильно, это может иметь физические, экологические или финансовые последствия. Знание аудитории важно для точности, потому что язык будет адаптирован в соответствии с тем, что они уже понимают по рассматриваемому предмету. Например, в комплект поставки входит инструкция, как правильно и безопасно собрать книжную полку. Эти инструкции составлены таким образом, чтобы каждый мог следовать им, включая точные сведения о том, где находится каждая застежка. Если бы эти инструкции были неточными, книжная полка могла бы работать нестабильно и выйти из строя.
Дизайн и макет документа также являются важными компонентами технического письма. Технические писатели тратят много времени на то, чтобы их документы были удобочитаемыми, потому что плохо разработанный документ затрудняет понимание читателем. Дизайн технического документа подчеркивает правильное использование таких вариантов дизайна документа, как маркированный список, размер шрифта и полужирный текст. Изображения, диаграммы и видео также часто используются техническими писателями, потому что эти носители часто могут передавать сложную информацию, такую как годовой доход компании или конструктивные особенности продукта, гораздо эффективнее, чем текст.
Технические документы
Техническое письмо охватывает многие жанры и стили письма, в зависимости от информации и аудитории. Техническая документация разрабатывается не только техническими писателями. Практически любой, кто работает в профессиональной среде, создает различные технические документы. Вот некоторые примеры технической документации:
- Инструкции и процедуры - это документы, которые помогают разработчикам или конечным пользователям управлять или настраивать устройство или программу. Примеры инструкций включают руководства пользователя и руководства по поиску и устранению неисправностей для компьютерных программ, компьютерного оборудования, бытовых товаров, медицинского оборудования, механических изделий и автомобилей.
- Предложения. Большинство проектов начинаются с предложение - документ, в котором описывается цель проекта, задачи, которые будут выполняться в рамках проекта, методы, используемые для завершения проекта, и, наконец, стоимость проекта. Предложения охватывают широкий круг вопросов. Например, технический писатель может составить предложение, в котором указывается, сколько будет стоить установка новой компьютерной системы, специалист по маркетингу может написать предложение с предложениями продуктов, а учитель может написать предложение, в котором описывается, как новый урок биологии будут структурированы.
- Электронные письма, письма и меморандумы являются одними из наиболее часто составляемых документов в компании. Письма и электронные письма могут быть созданы для различных целей - некоторые из них обычно направлены на простое сообщение информации, а другие предназначены для того, чтобы убедить получателя выполнить определенную задачу. В то время как письма обычно пишутся людям за пределами компании, меморандумы (служебные записки) - это документы, написанные другим сотрудникам внутри компании.
- Пресс-релизы. Когда компания хочет публично раскрыть новый продукт или услугу, у них будет писатель, автор пресс-релиза. Это документ, в котором описаны функции и ценность продукта для общественности.
- Спецификации представляют собой схемы дизайна, которые описывают структуру, части, упаковку и доставку объекта или процесса достаточно подробно, чтобы другая сторона может восстановить его. Например, технический писатель может составить схему и написать спецификации для смартфона или велосипеда, чтобы производитель мог произвести объект.
- Описания - это более короткие объяснения процедур и процессов, которые помогают читателям понять, как что-то работает. Например, технический писатель может составить документ, в котором показано воздействие парниковых газов или показано, как работает тормозная система на велосипеде.
- Резюме и заявления о приеме на работу - еще один пример. технической документации. Это документы, которые используются в профессиональной среде для информирования читателей о полномочиях автора.
- Технические отчеты написаны для предоставления читателям информации, инструкций и анализа задач. Отчеты бывают разных форм. Например, технический писатель может оценить здание, которое выставлено на продажу, и составить отчет о поездке, в котором освещаются его или ее выводы и то, считает ли он или она, что здание следует покупать. Другой писатель, который работает в некоммерческой компании, может опубликовать отчет об оценке, в котором отражены результаты исследования компании в области загрязнения воздуха.
- Пример из практики - опубликованный отчет о человеке, группе или ситуации. что было изучено с течением времени; также: ситуация из реальной жизни, которую можно посмотреть или изучить, чтобы что-то узнать. Например, сложная ситуация человека на его или ее рабочем месте и то, как он или она ее разрешили, представляет собой тематическое исследование.
- Официальные документы - это документы, которые написаны для экспертов в данной области и обычно описывают решение к технологическому или деловому вызову или проблеме. Примеры официальных документов включают в себя статью, в которой подробно рассказывается, как выделить компанию на рынке, или статью, объясняющую, как предотвратить кибератаки на компании.
- Веб-сайты. Появление гипертекста изменило способ чтения, организации и доступа к документам. Современные технические писатели часто несут ответственность за создание страниц на таких веб-сайтах, как страницы «О нас» или страницы продуктов. Часто ожидается, что они хорошо владеют инструментами веб-разработки.
- Таблицы данных - это документы, в которых резюмируются функции, ключевые характеристики, технические характеристики, схемы применения и некоторая другая важная информация о продукте, машине, вкратце об оборудовании, программном обеспечении, приложении или системе.
- Руководства по API написаны для сообщества разработчиков и используются для объяснения интерфейсов прикладного программирования.
- Справочные системы - это интерактивные справочные центры, которые предоставлять пользователям техническую информацию о продуктах и услугах. Они предоставляют контент в виде веб-страниц, которые просматриваются в браузере. Контент может быть создан в программном обеспечении справочного центра, таком как Zendesk, или в или системах управления содержимым компонентов, которые могут создать справочный центр как Вывод HTML.
Инструменты
Технические писатели используют следующие инструменты для создания и представления документов:
- Инструменты настольной публикации или текстовые процессоры. Технические писатели используют текстовые редакторы, такие как Scrivener, Microsoft Word, Apple Pages и LibreOffice Writer, для создания, редактирования, дизайна и печати документов. Поскольку техническое письмо - это столько же о макете страницы, сколько о письменном языке, также используются усовершенствованные инструменты настольной публикации, такие как Adobe InDesign и LyX. Эти программы работают так же, как текстовые процессоры, но предоставляют пользователям больше возможностей и функций для дизайна документа и автоматизируют большую часть форматирования.
- . Они используются техническими писателями для создания справочных систем которые упакованы с программными продуктами, доставляются через веб-браузеры или предоставляются в виде файлов, которые пользователи могут просматривать на своих компьютерах. При написании инструкций для описания механических, электрических или программных программ технические писатели используют эти инструменты, чтобы упростить им процессы сборки, эксплуатации или установки.
- Системы управления содержанием компонентов. Они также используются техническими писателями для создания справочных систем и документов. Системы управления компонентным контентом (CCMS) позволяют авторам создавать выходные данные, аналогичные инструментам разработки справки, но они также предоставляют функции управления контентом, такие как управление версиями и встроенные рабочие процессы.
- Программное обеспечение для редактирования изображений. Часто, изображения и другие визуальные элементы могут передавать информацию лучше, чем абзацы текста. В этих случаях программное обеспечение для редактирования изображений, такое как Adobe Photoshop и GIMP, используется техническими писателями для создания и редактирования визуальных аспектов документов, таких как фотографии, значки и диаграммы.
- Программы для совместной работы. Потому что часто пишут технические статьи предполагает общение между несколькими людьми, которые работают в разных компаниях, это может быть совместное дело. Технические писатели используют Wiki Systems и общие рабочие пространства для документов для работы с другими авторами и сторонами для создания технических документов.
- Инструменты веб-разработки. Работа технических писателей больше не ограничивается просто предъявляю документы. Иногда они также создают контент для корпоративных и других профессиональных веб-сайтов. Поэтому можно ожидать, что технические писатели будут хорошо разбираться в таких инструментах веб-разработки, как Adobe Dreamweaver.
- ., таких как Microsoft Notepad, TextEdit или Wordstar. разрешить техническим писателям редактировать обычный текст. Текстовые редакторы могут использоваться для изменения содержимого, такого как файлы конфигурации, файлы документации и язык программирования исходный код. Текстовые редакторы широко используются техническими писателями, работающими с онлайн-контентом.
- Программное обеспечение для построения графиков. Для передачи статистической информации, такой как количество посещений ресторана или суммы денег, которые университет тратит на свои спортивные программы, технические писатели использовать графики и блок-схемы. В то время как такие программы, как Microsoft Excel и Word, могут создавать простые графики и диаграммы, иногда техническим писателям приходится создавать более сложные и подробные графики, для которых требуются функции, недоступные в этих программах, и, возможно, потребуется обратиться к инструментам построения графиков и диаграмм (например, Microsoft Visio ).
- Инструменты захвата экрана. Технические писатели часто используют инструменты захвата экрана, такие как Camtasia и Snagit. При создании инструкций для компьютерного программного обеспечения это может быть проще для технического писателя. просто записать короткое видео своих рабочих столов по мере выполнения задачи, чем написать длинную серию инструкций, описывающих, как эта задача должна быть выполнена. Инструменты захвата экрана также используются для создания снимков экрана программ и программного обеспечения, запущенных на компьютере пользователя компьютеров, а затем для создания сопроводительных диаграмм.
Список ассоциаций
Ссылки
Внешние ссылки
