09 02 07 информационные системы и программирование технический писатель

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

Общество технической коммуникации определяет техническую коммуникацию как любую форму коммуникации. Которая проявляет одну или несколько из следующих характеристик: (2) общение с помощью технологий. Таких как веб-страницы. Файлы справки или сайты социальных сетей; или (3) предоставление инструкций о том. Как что-то сделать. Независимо от того. Насколько техническая задача

[2]

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

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

В то время как техническое письмо обычно ассоциируется с онлайн-справкой и руководствами пользователя, термин Пресс-релизы, памятки, отчеты, бизнес-предложения, спецификации, описания продуктов и технические характеристики, официальные документы, резюмеи заявления о приеме на работу-это лишь несколько примеров написания . Которые можно считать технической документацией.

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

Хотя техническое письмо было признано профессией только после Второй мировой войны, его корни можно проследить до классической древности. Критики ссылаются на труды таких писателей. Как Аристотель,

как на самые ранние формы технического письма.Работа Джеффри Чосера об астролябии технического документа. Самые ранние примеры технического письма относятся к староанглийскому периоду.[9]

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

[6]

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

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

После Второй мировой войнытехнический прогресс привел к росту потребительских товаров и повышению уровня жизни.

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

Изобретение транзистора в 1947 году позволило производить компьютеры дешевле. Чем когда-либо прежде.

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

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

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

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

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

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

Технические документы

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

  • Инструкции и процедуры-это документы. Которые помогают разработчикам или конечным пользователям управлять или настраивать устройство или программу.[12]:226 Примеры учебных документов включают руководства пользователя и руководства по устранению неполадок для компьютерных программ. Компьютерного оборудования. Бытовых товаров. Медицинского оборудования. Механических изделий и автомобилей.
  • Большинство проектов начинаются с предложения—документа. Описывающего цель проекта, задачи. Которые будут выполняться в рамках проекта, методы. Используемые для завершения проекта. И, наконец. Стоимость проекта . Например. Технический писатель может написать предложение. В котором будет указано. Сколько будет стоить установка новой компьютерной системы. Специалист по маркетингу может написать предложение с описанием предлагаемых продуктов. А учитель может написать предложение. В котором будет описана структура нового класса биологии.
  • Электронныеписьма, письма и меморандумы являются одними из наиболее часто пишущихся документов в бизнесе.[12]:117 Письма и электронные письма могут быть построены с различными целями—некоторые из них обычно направлены на простое сообщение информации. В то время как другие предназначены для того. Чтобы убедить получателя выполнить определенную задачу. В то время как письма обычно пишутся людям за пределами компании, меморандумы (памятки) — это документы. Написанные другим сотрудникам внутри компании.[12]:118
  • Когда компания хочет публично раскрыть новый продукт или услугу. У нее будет автор пресс-релиза . Это документ. Который описывает функции продукта и его ценность для общественности.]
  • Спецификации-это контуры дизайна. Которые описывают структуру, детали. Упаковку и доставку объекта или процесса достаточно подробно. Чтобы другая сторона могла реконструировать его.[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 Notepad, TextEditили Wordstar, позволяют техническим авторам редактировать обычный текст . Текстовые редакторы можно использовать для изменения содержимого . Такого как файлы конфигурации, файлы документации и исходный код языка программирования. Текстовые редакторы широко используются техническими авторами. Работающими с онлайн-контентом.
  • Графическое программное обеспечение. Для передачи статистической информации. Такой как количество посещений ресторана или сумма денег. Которые университет тратит на свои спортивные программы. Технические авторы используют графики и блок-схемы.[3]:306-307 В то время как такие программы. Как Microsoft Excel и Word. Могут создавать базовые графики и диаграммы. Иногда технические авторы должны создавать более сложные и подробные графики. Для которых требуются функции. Недоступные в этих программах. И, возможно. Потребуется обратиться к инструментам построения графиков и диаграмм (например, Microsoft Visio).]
  • Инструменты захвата экрана. Технические писатели часто используют инструменты захвата экрана. Такие как Camtasia и Snagit.[22][23] При создании инструкций для компьютерных программ техническому писателю может быть проще просто записать короткое видео своих рабочих столов по мере выполнения задачи. Чем написать длинную серию инструкций. Описывающих. Как эта задача должна быть выполнена. Инструменты захвата экрана также используются для создания скриншотов программ и программного обеспечения. Работающих на компьютерах пользователей. А затем для создания сопутствующих диаграмм.

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

  1. ^
  2. ^ . Общество технической коммуникации. Извлечено 10 февраля 2019года .
  3. ^ b c d e f g h i j k l m n o Майк Маркел (2012). Техническая Коммуникация 10-е издание. Бедфорд/Сент-Мартинс.
  4. ^ Джонсон, Том (19 декабря 2011 г.). . Я Бы Предпочел Писать. Извлечено 4 мая 2014года .
  5. ^ Перельман, Лесли К.; Барретт. Эдвард; Рай Джеймс. . Мейфилдское руководство по технической и научной литературе. Извлечено 4 мая 2014года .
  6. ^ b c d e f g h i j k l O’Hara. Fredrick M. Jr. (PDF). Биллингс из Университета штата Монтана. Проверено 22 апреля 2014года .
  7. ^ b Doody, Aude; Follinger, Sabine; Taub, Liba (8 февраля 2012). (PDF). Исследования по истории и философии науки. Кембриджский Университет. 43 (2): 233–236. doi:10.1016/j.shpsa.2011.12.021. Архивирован из оригинала (PDF) 3 августа 2012года . Проверено 22 апреля 2014года .
  8. ^ . Колледж Святого Иоанна. Извлечено 22 апреля 2014года .
  9. ^ Хагге, Джон (июль 1990). . Журнал технического письма и коммуникации. 20 (3): 269-289. doi:10.2190/vwcw-xkmv-949f-vlf7. ISSN 0047-2816.
  10. ^ b c Крэбб. Стивен (2012). (PDF). Портсмутский университет. Архивировано с оригинала (PDF) 12 мая 2014года . Извлечено 30 апреля 2014года .
  11. ^ . Проредит. 14 сентября 2012года . Извлечено 9 мая 2014года .
  12. ^ b c d e f g h Tebeaux, Elizabeth; Dragga, Sam (2010). Основы технической коммуникации. Издательство Оксфордского университета.
  13. ^ Diane Martinez, et. al.,
  14. ^ Уоллер, Роб (апрель 2011). — Что делает Документ Хорошим? Критерии, которые мы используем (PDF). Университет Рединга: 16-19. Извлечено 4 мая 2014года .
  15. Перельман, Лесли К., Барретт. Эдвард и Паради Джеймс. The Mayfield grave naba Handbook of Technical & Scientific Writing. Извлечено 4 мая 2014 года.
  16. Перельман, Лесли К., Барретт. Эдвард и Паради Джеймс. Справочник Мэйфилда по техническому и научному письму. Извлечено 4 мая 2014 года.
  17. ^ . www.merriam-webster.com. Проверено 2016-01-22.
  18. ^ b Anderson. Paul V. (2007). Техническая коммуникация [Подход. Ориентированный на читателя] 6-е издание. Томпсон Уодсворт.
  19. ^ Джонсон, Том 19 декабря 2011 года. Извлечено 4 мая 2014 года.
  20. ^ . Ликс. Извлечено 9 мая 2014 года.
  21. ^ Хьюитт, Джон (18 января 2005). . Война По. Архивирован с оригинала 12 мая 2014года . Извлечено 9 мая 2014года .
  22. ^ Брайерли, Шон (2002). Снимки экрана 102 (PDF). STC Carolina (Report). Стр. 5-8. Извлечено 9 мая 2014года .
  23. ^ Джонсон, Том (19 декабря 2011 года). . Я Бы Предпочел Писать. Извлечено 4 мая 2014года .

Внешние ссылки