Техническое письмо - Technical writing

Техническое письмо пишет или готовит техническая коммуникация используется в технических и профессиональных областях, таких как компьютерное железо и программного обеспечения, инженерное дело, химия, воздухоплавание, робототехника, финансы, медицинский, бытовая электроника, биотехнология, и лесное хозяйство. Техническое письмо включает в себя крупнейшее подразделение технической коммуникации.[1]

В Общество технической коммуникации определяет техническая коммуникация как любая форма коммуникации, которая демонстрирует одну или несколько из следующих характеристик: «(1) общение на технические или специализированные темы, такие как компьютерные приложения, медицинские процедуры или экологические нормы; (2) общение с использованием технологий, таких как веб-страницы , файлы справки или сайты социальных сетей; или (3) предоставление инструкций о том, как что-то делать, независимо от того, насколько технически задача ".[2]

Обзор

Дальнейшая информация: Технический писатель

Техническое написание выполняется технический писатель (или технический автор) и представляет собой процесс написания и обмена технической информацией в профессиональной среде.[3]:4 Основная задача технического писателя - передать техническую информацию другому лицу или стороне самым ясным и эффективным способом.[3]:4 Информация, которую сообщают технические писатели, часто бывает сложной, поэтому необходимы сильные письменные и коммуникативные навыки. Технические писатели не только передают информацию через текст, но они также должны хорошо разбираться в компьютерах. Технические писатели используют широкий спектр программ для создания и редактирования иллюстрации, программы построения диаграмм для создания наглядных пособий и обработчики документов для проектирования, создания и форматирования документов.[4]

Хотя техническое описание обычно связано с онлайн-справкой и руководства пользователя, термин техническая документация может охватывать более широкий диапазон жанров и технологий. пресс-релизы, записки, отчеты, деловые предложения, таблицы, описания продуктов и технические характеристики, белые бумаги, резюме, и заявления о приеме на работу это всего лишь несколько примеров написания, которые можно рассматривать как техническую документацию.[5] Некоторые типы технической документации обычно не обрабатываются техническими писателями. Например, пресс-релиз обычно пишется писателем по связям с общественностью, хотя технический писатель может вносить свой вклад в любую техническую информацию, включенную в пресс-релиз.

История

Хотя техническое письмо было признано профессией только с тех пор, как Вторая Мировая Война,[6]:2 его корни можно проследить до классическая древность.[7]:233 Критики цитируют произведения таких писателей, как Аристотель как самые ранние формы технического письма.[7]:234 Джеффри Чосера работа "Трактат об астролябии" является одним из первых примеров технический документ.[8] Самые ранние примеры технического письма относятся к древнеанглийскому периоду.[9]

С изобретением механического печатный станок, начало эпоха Возрождения и рост Возраст разума, документирование результатов стало необходимостью. Изобретателям и ученым нравится Исаак Ньютон и Леонардо да Винчи подготовили документы, в которых описывались их изобретения и открытия.[6]:1 Хотя эти документы никогда не назывались техническими документами в период их публикации, они сыграли решающую роль в развитии современных форм технической коммуникации и письма.[6]

Область технической коммуникации выросла во время Индустриальная революция.[10]:3 Возникла потребность в предоставлении людям инструкций по использованию изобретаемых все более сложных машин.[10]:8 Однако, в отличие от прошлого, когда навыки передавались через устные традиции, никто, кроме изобретателей, не знал, как использовать эти новые устройства. Таким образом, письмо стало самым быстрым и эффективным способом распространения информации, и были нужны писатели, которые могли бы документировать эти устройства.[10]

В течение 20 века потребность в техническом письме резко возросла, и эта профессия, наконец, получила официальное признание. События Первая Мировая Война и Вторая Мировая Война привел к достижениям в медицине, военной технике, компьютерных и аэрокосмических технологиях.[6]:2 Этот быстрый рост в сочетании с безотлагательностью войны вызвали немедленную потребность в хорошо разработанных и письменных документах, описывающих использование этих технологий. Техническое письмо было очень востребовано в то время, и "технический писатель" стал официальным названием должности в течение этого времени. Вторая Мировая Война.[6]:1

Следующий Вторая Мировая Война, технический прогресс привел к повышению потребительских товаров и уровня жизни.[6]:3 Во время послевоенного бума государственные службы, такие как библиотеки и университеты, а также транспортные системы, такие как автобусы и шоссе, пережили огромный рост. Потребность писателей в записи этих процессов возрастала.[6]:1 Также в этот период крупный бизнес и университеты начали использовать компьютеры. Примечательно, что в 1949 году Джозеф Д. Чаплин создал первый вычислительный технический документ - руководство по эксплуатации БИНАК компьютер.[11]

Открытие транзистор в 1947 году позволил производить компьютеры дешевле, чем когда-либо прежде.[6]:3 Эти сниженные цены означали, что компьютеры теперь могли приобретать частные лица и малые предприятия.[6]:3 И в результате растущей известности компьютеров возросла потребность в писателях, которые могли бы объяснить и задокументировать эти устройства.[6]:3 Профессия технического писателя продолжала расширяться в 1970-х и 1980-х годах, когда бытовая электроника находила все больше и больше людей в домах.[6]

В последние годы известность компьютеров в обществе привела ко многим достижениям в области цифровых коммуникаций, что привело к изменениям в инструментах, которые используют технические писатели.[6]:3 Гипертекст, текстовые процессоры, программы редактирования графики, и программное обеспечение для верстки страниц сделало создание технических документов быстрее и проще, и современные технические писатели должны хорошо владеть этими программами.[3]:8–9

Методы

Хороший технический текст должен быть кратким, целенаправленным, легким для понимания, без ошибок и ориентированным на аудиторию.[12]:7 Технические писатели стараются сделать свои документы максимально понятными, избегая излишне технических фраз и стилистических предпочтений, таких как пассивный залог и номинализации.[3]:236–245 Поскольку технические документы используются в реальных ситуациях, всегда должно быть четко указано, что является предметом технического документа и как использовать представленную информацию. Было бы катастрофой, если бы, например, инструкции технического писателя о том, как пользоваться мощным рентгеновским аппаратом, было трудно расшифровать.

Техническое письмо требует от писателя тщательного изучения своей аудитории.[3]:84–114 Технический писатель должен быть осведомлен об имеющихся у своей аудитории знаниях о материале, который они обсуждают, поскольку база знаний писательской аудитории определяет содержание и направленность документа.[3]:84–114 Например, отчет об оценке, в котором обсуждаются результаты научного исследования, который написан группе высококвалифицированных ученых, будет составлен совершенно иначе, чем отчет, предназначенный для широкой публики. Технические писатели не должны быть профильные эксперты (МСП) сами. Они часто сотрудничают с МСП для выполнения задач, требующих большего знания предмета, чем они обладают.[3]:51

Техническое письмо должно быть точным. Технический писатель, проанализировав свою аудиторию, знает, что им нужно сообщить, а затем должен передать сообщение точным и этичным образом. Если автор сделает это неправильно, это может иметь физические, экологические или финансовые последствия. Знание аудитории важно для точности, потому что язык будет адаптирован в соответствии с тем, что они уже понимают по рассматриваемому предмету. Например, в комплект поставки входит инструкция, как правильно и безопасно собрать книжную полку. Эти инструкции составлены таким образом, чтобы каждый мог следовать им, включая точные сведения о том, где находится каждая застежка. Если эти инструкции были неточными, книжная полка могла выйти из строя и выйти из строя.[13]

Дизайн и верстка документа также являются жизненно важными компонентами технического письма.[3]:261–286 Технические писатели тратят много времени на то, чтобы их документы были удобочитаемыми, потому что плохо разработанный документ затрудняет понимание читателем. Дизайн технического документа подчеркивает правильное использование таких вариантов дизайна документа, как маркированный список, размер шрифта и полужирный текст.[14] Изображения, диаграммы и видео также обычно используются техническими писателями, потому что эти носители часто могут передавать сложную информацию, такую ​​как годовой доход компании или особенности дизайна продукта, гораздо более эффективно, чем текст.[3]:306–307

Техническая документация

Техническое письмо охватывает многие жанры и стили письма, в зависимости от информации и аудитории.[3]:84–114 Техническая документация разрабатывается не только техническими писателями. Практически любой, кто работает в профессиональной среде, создает различные технические документы. Некоторые примеры технической документации включают:

  • инструкции и процедуры - это документы, которые помогают разработчикам или конечным пользователям управлять или настраивать устройство или программу.[12]:226 Примеры учебных документов включают: руководства пользователя и руководства по поиску и устранению неисправностей для компьютерных программ, компьютерного оборудования, бытовых товаров, медицинского оборудования, механических изделий и автомобилей.
  • Предложения. Большинство проектов начинаются с предложения - документа, в котором описывается цель проекта, задачи, которые будут выполнены в рамках проекта, методы, используемые для завершения проекта, и, наконец, стоимость проекта.[12]:191 Предложения охватывают широкий круг вопросов. Например, технический писатель может составить предложение, в котором указывается, сколько будет стоить установка новой компьютерной системы, специалист по маркетингу может написать предложение с предложениями продуктов, а учитель может написать предложение, в котором описывается, как новый урок биологии будут структурированы.
  • Электронные письма, буквы, и меморандумы являются одними из наиболее часто составляемых документов в бизнесе.[12]:117 Письма и электронные письма могут быть сконструированы с различными целями - некоторые из них обычно направлены на простую передачу информации, а другие предназначены для того, чтобы убедить получателя выполнить определенную задачу. Хотя письма обычно пишут людям за пределами компании, меморандумы (служебные записки) - это документы, адресованные другим сотрудникам компании.[12]:118
  • пресс-релизы. Когда компания хочет публично раскрыть новый продукт или услугу, у нее будет писатель, автор пресс-релиз. Это документ, в котором описаны функции продукта и его ценность для общества.[15]
  • Характеристики представляют собой схемы проекта, которые описывают структуру, части, упаковку и доставку объекта или процесса достаточно подробно, чтобы другая сторона могла их реконструировать.[16] Например, технический писатель может составить схему и написать спецификации для смартфона или велосипеда, чтобы производитель мог произвести объект.
  • Описания - это более короткие объяснения процедур и процессов, которые помогают читателям понять, как что-то работает.[3]:564 Например, технический писатель может написать документ, в котором показано воздействие парниковых газов или показано, как работает тормозная система на велосипеде.
  • Резюме и заявления о приеме на работу еще один пример технической документации.[12]:284–285 Это документы, которые используются в профессиональной среде для информирования читателей о полномочиях автора.
  • Технические отчеты написаны для предоставления читателям информации, инструкций и анализа задач.[12]:141–143 Отчеты бывают разных форм. Например, технический писатель может оценить здание, которое выставлено на продажу, и составить отчет о поездке, в котором освещаются его или ее выводы и то, считает ли он или она, что здание следует покупать. Другой писатель, который работает в некоммерческой компании, может опубликовать отчет об оценке, в котором отражены результаты исследований компании в области загрязнения воздуха.
  • Пример использования это опубликованный отчет о человеке, группе или ситуации, который изучался в течение долгого времени; также : ситуация в реальной жизни, которую можно посмотреть или изучить, чтобы узнать о чем-то.[17] Например, сложная ситуация человека на его или ее рабочем месте и то, как он или она ее разрешили, - это тематическое исследование.
  • белые бумаги - это документы, написанные для экспертов в данной области и обычно описывающие решение технологических или бизнес-задач или проблем.[12]:644 Примеры официальных документов включают статью, в которой подробно рассказывается, как выделить бизнес на рынке, или статью, объясняющую, как предотвратить кибератаки на бизнес.
  • Сайты. Появление гипертекста изменило способ чтения, организации документов и доступа к ним. Современные технические писатели часто несут ответственность за создание страниц на таких веб-сайтах, как страницы «О нас» или страницы продуктов. Часто ожидается, что они хорошо разбираются в инструментах веб-разработки.[18]:484–504
  • Даташиты представляют собой документы, в которых кратко описаны функции, ключевые характеристики, технические характеристики, схемы приложений и некоторая другая важная информация о продукте, машине, оборудовании, программном обеспечении, приложении или системе.
  • Руководства по API написаны для сообщества разработчиков и используются для объяснения интерфейсы прикладного программирования.
  • Системы помощи - это интерактивные справочные центры, которые предоставляют пользователям техническую информацию о продуктах и ​​услугах. Они предоставляют контент в виде веб-страниц, которые просматриваются в браузере. Контент может быть создан в программном обеспечении Справочного центра, таком как Zendesk, или в помощь в инструментах разработки или же компонентные системы управления контентом который может создать справочный центр в виде HTML-вывода.

Инструменты

Следующие инструменты используются техническими писателями для создания и представления документов:

  • Инструменты настольной публикации или же текстовые процессоры. Технические писатели используют текстовые редакторы, такие как Scrivener, Microsoft Word, Apple Pages, и LibreOffice Writer для создания, редактирования, дизайна и печати документов. Поскольку технический текст - это не только письменный язык, но и макет страницы, улучшенные инструменты настольной публикации, такие как Adobe InDesign и LyX также используются.[19] Эти программы работают аналогично текстовым редакторам, но предоставляют пользователям больше возможностей и функций для дизайна документа и автоматизируют большую часть форматирования.[20]
  • Помощь в инструментах разработки. Они используются техническими писателями для создания справочных систем, которые упакованы с программными продуктами, доставляются через веб-браузеры или предоставляются в виде файлов, которые пользователи могут просматривать на своих компьютерах. При написании инструкций для описания механических, электрических или программных программ технические писатели используют эти инструменты, чтобы помочь им упростить процессы сборки, эксплуатации или установки.
  • Компонентные системы управления контентом. Они также используются техническими писателями для создания справочных систем и документов. Системы управления компонентным контентом (CCMS) позволяют авторам создавать выходные данные, аналогичные инструментам создания справки, но они также предоставляют функции управления контентом, такие как управление версиями и встроенные рабочие процессы.
  • Программное обеспечение для редактирования изображений. Часто изображения и другие визуальные элементы могут передавать информацию лучше, чем абзацы текста.[3]:306–307 В этих случаях программное обеспечение для редактирования изображений, такое как Adobe Photoshop и GIMP, используется техническими писателями для создания и редактирования визуальных аспектов документов, таких как фотографии, значки и диаграммы.
  • Совместное программное обеспечение. Поскольку написание технических документов часто предполагает общение между несколькими людьми, которые работают в разных компаниях, это может быть совместное дело.[3]:57 Технические писатели используют Вики-системы и общие рабочие места для работы с документами для работы с другими авторами и сторонами для создания технических документов.[3]:74
  • Инструменты веб-разработки. Работа технического писателя больше не ограничивается только созданием документов. Иногда они также создают контент для корпоративных и других профессиональных веб-сайтов.[18]:485 Поэтому можно ожидать, что технические писатели будут хорошо разбираться в таких инструментах веб-разработки, как Adobe Dreamweaver.
  • Текстовый редактор. Такие программы как Блокнот Microsoft, TextEdit, или же Wordstar разрешить техническим писателям редактировать простой текст. Текстовые редакторы можно использовать для изменения содержимого, например файлы конфигурации, файлы документации и язык программирования исходный код. Текстовые редакторы широко используются техническими писателями, работающими с онлайн-контентом.
  • Программное обеспечение для построения графиков. Для передачи статистической информации, такой как количество посещений ресторана или сумма денег, которую университет тратит на свои спортивные программы, технические писатели используют графики и блок-схемы.[3]:306–307 В то время как такие программы, как Microsoft Excel и Word, могут создавать простые графики и диаграммы, иногда техническим писателям приходится создавать более сложные и подробные графики, для которых требуются функции, недоступные в этих программах, и, возможно, потребуется обратиться к инструментам построения графиков и диаграмм (например, Microsoft Visio ).[21]
  • Инструменты захвата экрана. Технические писатели часто используют инструменты захвата экрана, такие как Camtasia и Снагит[22][23]. При создании инструкций для компьютерного программного обеспечения техническому писателю может быть проще просто записать короткое видео своих рабочих столов по мере выполнения задачи, чем написать длинную серию инструкций, описывающих, как задача должна быть выполнена. Инструменты захвата экрана также используются для создания снимков экрана программ и программного обеспечения, работающих на компьютерах пользователей, а затем для создания сопроводительных диаграмм.

Список ассоциаций

Рекомендации

  1. ^ Что такое технические коммуникации? TechWhirl. Проверено 9 декабря 2014 г.
  2. ^ «Определение технической коммуникации». Общество технической коммуникации. Получено 10 февраля, 2019.
  3. ^ а б c d е ж грамм час я j k л м п о Майк Маркел (2012). Техническое сообщение, 10-е издание. Бедфорд / ул. Мартинс.
  4. ^ Джонсон, Том (19 декабря 2011 г.). «Какие инструменты используют технические писатели». Я лучше буду писать. Получено 4 мая, 2014.
  5. ^ Перельман, Лесли С .; Барретт, Эдвард; Паради Джеймс. «Типы документов». Справочник Mayfield по техническому и научному письму. Получено 4 мая, 2014.
  6. ^ а б c d е ж грамм час я j k л О'Хара, Фредрик М. мл. «Краткая история технической коммуникации» (PDF). Университет штата Монтана, Биллингс. Получено 22 апреля, 2014.
  7. ^ а б Дуди, Од; Фоллингер, Сабина; Тауб, Либа (8 февраля 2012 г.). «Структуры и стратегии в древнегреческом и римском техническом письме: введение» (PDF). Исследования по истории и философии науки. Кембриджский университет. 43 (2): 233–236. Дои:10.1016 / j.shpsa.2011.12.021. Архивировано из оригинал (PDF) 3 августа 2012 г.. Получено 22 апреля, 2014.
  8. ^ «Путь к звездам: создай свою собственную астролябию». Колледж Святого Иоанна. Получено 22 апреля, 2014.
  9. ^ Хэгге, Джон (июль 1990). «Первый технический писатель на английском языке: вызов гегемонии Чосера». Журнал технического письма и коммуникации. 20 (3): 269–289. Дои:10.2190 / vwcw-xkmv-949f-vlf7. ISSN  0047-2816.
  10. ^ а б c Крэбб, Стивен (2012). «Создание контекстуальной истории технического письма на английском языке» (PDF). Портсмутский университет. Архивировано из оригинал (PDF) 12 мая 2014 г.. Получено 30 апреля, 2014.
  11. ^ «История технического письма». Proedit. 14 сентября 2012 г.. Получено 9 мая, 2014.
  12. ^ а б c d е ж грамм час Тебо, Элизабет; Драгга, Сэм (2010). Основы технической коммуникации. Издательство Оксфордского университета.
  13. ^ Дайан Мартинес и др. др., «Техническое письмо: комплексный ресурс для технических писателей на всех уровнях».
  14. ^ Уоллер, Роб (апрель 2011 г.). «Что делает документ хорошим? Критерии, которые мы используем» (PDF). Университет Ридинга: 16–19. Получено 4 мая, 2014.
  15. ^ Перельман, Лесли К., Барретт, Эдвард и Паради Джеймс. "Пресс Джейлан Перегрино". Справочник по техническому и научному письму Mayfield grave naba. Проверено 4 мая 2014 года.
  16. ^ Перельман, Лесли К., Барретт, Эдвард и Паради Джеймс. "Характеристики." Справочник Mayfield по техническому и научному письму. Проверено 4 мая 2014 года.
  17. ^ "Словарь и тезаурус | Мерриам-Вебстер". www.merriam-webster.com. Получено 2016-01-22.
  18. ^ а б Андерсон, Пол В. (2007). Техническая коммуникация [подход, ориентированный на читателя] 6-е издание. Томпсон Уодсворт.
  19. ^ Джонсон, Том «Какие инструменты используют технические писатели». Я лучше буду писать. 19 декабря 2011 г. Проверено 4 мая 2014 г.
  20. ^ "Что такое LyX". LyX. Проверено 9 мая 2014 года.
  21. ^ Хьюитт, Джон (18 января 2005 г.). «Как технические писатели используют Microsoft Visio». По Война. Архивировано из оригинал 12 мая 2014 г.. Получено 9 мая, 2014.
  22. ^ Бриерли, Шон (2002). Снимки экрана 102 (PDF). STC Carolina (Отчет). стр. 5–8. Получено 9 мая, 2014.
  23. ^ Джонсон, Том (19 декабря 2011 г.). «Какие инструменты используют технические писатели». Я лучше буду писать. Получено 4 мая, 2014.

внешняя ссылка