Разработка технической документации
 

Кто такие технические писатели?

Кто такие технические писатели?

Зачем нужны технические писатели?


Что такое “технический писатель” представляют себе немногие. Вкратце рассмотрим, кто такие технические писатели вообще, и чем конкретно они занимаются. Популярной эта профессия стала в первую очередь, благодаря развитию информационных технологий. Компании-разработчики нового оборудования, приборов, высокотехнологичных изделий, программного обеспечения, построения комплексных сетей в настоящее время нуждаются в специалистах, способных доступно и толково объяснить пользователям и заказчикам, как со всем этим работать. В инженерно-конструкторской сфере технические писатели востребованы в меньшей степени: частных фирм-производителей, имеющих собственные конструкторские отделы немного, а в государственных НИИ и конструкторских бюро технической документацией обычно занимаются инженеры.

Как про это написано в Wiki:" технический писатель (на английском technical writer, technical author) - род занятий, профессия.

Технический писатель документирует некоторый объект или процесс. Его задача состоит в том, чтобы написать текст - техническую документацию - который был бы полезен для целевой аудитории, точен, читаем и доступен".

Почему разработчики сами не могут написать документацию к своим творениям? Главное – доходчиво объяснить читателю сложные вещи. Разработчики, как правило, этого делать не умеют: то, что для них очевидно и не требует дополнительных разъяснений рядовому пользователю абсолютно непонятно. У квалифицированных программистов нет времени писать подобные руководства – им нужно разрабатывать следующий программный продукт, поэтому и необходим специалист, готовый взять на себя эту работу. Кроме того, претерпела изменения сама технология разработки и использования как конструкторской, так и текстовой документации. Обычно вся документация предлагается еще и в электронном виде, чтобы удобно было искать информацию. Электронную версию тоже готовит технический писатель, а это предполагает использование специального программного обеспечения.

Следует различать разработку технической документации на конкретное изделие и на программные продукты. Это несколько разные технологии. В последующем будут отмечаться нюансы, им сопутствующие.

Что нужно знать и уметь, чтобы работать техническим писателем

В первую очередь знать предмет, т.е. или изделие, или программу, разбираться в технических вопросах (компетентность).
Если речь идет об изделии, то надо знать принцип действия, состав, свойства, терминологию, описывающую упомянутое. Следует иметь в виду, что терминология бывает достаточно узкопрофессиональной, и в какой то мере не совсем соответствовать приводимой в нормативной документации. В таких случаях бывает полезен компромисс, когда технические условия на изделие составляют в соответствии с официально принятой терминологией, а руководства по эксплуатации с употреблением проф. жаргона, смотри также.
Что касается составления технической документации на программные продукты, то если технический писатель пишет руководство по эксплуатации для обычных пользователей программы, ему достаточно хорошо знать ее и уметь ею пользоваться. Другое дело, когда приходится творить для программистов, занимающихся установкой и наладкой этого программного обеспечения. Тут поверхностными знаниями не обойтись, нужна серьезная подготовка, чтобы не выглядеть в глазах специалистов дилетантом. Да и с отечественной терминологией бывает еще сложнее, учитывая, что весь Hard&Soft появились у нас с большим опозданием. Взять хотя бы попытку сделать из винчестера жесткий диск. Так что, терминологию предпочтительнее использовать более близкую к оригинальной т.е. английской. 
  • Знать нормы государственных стандартов (ГОСТы, СТБ, ТКП) и международные стандарты документирования. Причем знать их досконально. Пробелы приходится после встреч с экспертами устранять корректировками. Следует пользоваться актуализированными (зарегистрированными в органах стандартизации и со всеми проведенными изменениями ) стандартами.
  • Владеть базовыми навыками программирования при работе с программными продуктами.
  • Ясно выражать свои мысли в тексте, здесь же и предполагается грамотность (правила орфографии, пунктуации).
  • Владеть инструментарием, сюда относятся:
    • универсальные:
    • программы для работы с текстом (Word, Excel, Visio);
    • разные компьютерные программы для работы с текстом, чтобы не пытаться в течение нескольких часов героическими усилиями реализовать в Word`е то, что с помощью другой программы делается за 15 минут;
    • программы - редакторы для работы с графикой: AutoCAD, Corel Draw, Adobе Photoshop (как известно, лучше один раз увидеть, чем тысячу раз услышать);
    • программы для создания документов в формате PDF, в котором пишется вся электронная документация (например, Adobe Acrobat), либо конвертеры.
    • специфические для работы с программными продуктами:
    • программы для создания электронной справки (например, Help&Manual)
    • языки программирования
    • язык разметки HTML.
    • Знать иностранные языки – зачастую требуется совмещение функции технического писателя и технического переводчика. Без знания английского языка, конструирование - системо и схемотехника, серьезная работа в сфере информационных технологий нереальны.

Что приходится делать?


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

Лучше, когда работа одним «писательством» не ограничивается. Если самому все сверстать, сделать графику, выверить орфографию, оформить свою работу, сделать брошюру, чтобы ее потом могли напечатать в типографии, то будет меньше неожиданностей/неприятностей в результате кооперации с соисполнителями.

Следует иметь в виду, что мало кому нужен кодер/оператор просто набивающий текст в Word`е. Иногда необходим профи, на которого можно повесить и другие обязанности: составление не только эксплуатационной, но и технической документации. В этом случае приходится формулировать для заказчика концепцию, техническое задание для специалистов, готовить документы эскизного и технического проекта и т. д. Эта работа вроде не основная, но, как правило, инженеры настолько перегружены делами, что все обязанности по написанию этого вида документации перекладываются на плечи технического писателя.

Изделия и программные продукты регулярно подвергаются модернизации, появляются новые исполнения, устраняются ошибки, добавляются новые полезные свойства. Документация должна «бежать» за ними – регулярно обновляться, вводится описание дополнительных возможностей и т. д. 
Поэтому необходимо активное общение с пользователями изделий/программных продуктов, а также участие в тестировании продукции.

Что поможет? 

– Терпение, внимание, желание во всем разобраться.

Статья пришла отсюда

От себя добавим, что для профессионального роста вам просто необходимо: 


Возврат к списку


Это нравится:0Да/0Нет
''''writer''''
Пару слов о том кто такие технические писатели.
Имя Цитировать Это нравится:0Да/0Нет
 
Текст сообщения*
Загрузить файл или картинкуПеретащить с помощью Drag'n'drop
Перетащите файлы
Ничего не найдено
Отправить Отменить