Технический писатель: роскошь или ...?

2001 год

До выхода на подруб или подпил должен быть оставлен
недопил, производить сквозной пропил дерева
без недопила запрещается.
Из инструкции по технике безопасности

Лифтер может допускаться к работе
только по назначению и в пределах
его номинальной грузоподъемности.
Из инструкции

Когда родился мой младший брат, папа пошел в магазин и купил кроватку. Естественно, она продавалась в разобранном виде. Дома мы достали из упаковки все детали и инструкцию по сборке страниц на десять. По стилю и запутанности изложения она вполне могла сойти за руководство по сборке новейшего истребителя. Прочитав ее первую страницу, папа обозвал составителей идиотами и собрал кровать, следуя интуиции.

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

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

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

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

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

Для того, чтобы технический писатель состоялся, необходим человек, обладающий одновременно как техническим складом ума, для полного осознания предмета описания, так и гуманитарным, для внятного изложения своих мыслей на бумаге. И при всём при этом такой человек должен выказывать неподдельный интерес к своей работе - только тогда можно получить грамотное и интересное руководство пользователя, гармонично дополняющее программный продукт и являющееся его неотъемлемой частью.
Согласитесь, увязать такие качества в одном человеке трудно, поэтому на сегодняшний день технические писатели в большом дефиците.

Крупные производители программного обеспечения видят решение этой проблемы в привлечении специализированных фирм, занимающихся исключительно разработкой и написанием технической документации. И услуги таких фирм ценятся, как правило, высоко. Что же делать тем компаниям, в чьи планы не входят крупные капиталовложения в проекты?
В компании «1-й Архитектор бизнеса» решили, что производство коробочных программных продуктов с дальнейшим их тиражированием не может быть успешным без специальной рабочей группы, включающей технического писателя. При этом он логично совмещает написание технической документации с итоговым тестированием программы для подтверждения всех заявленных функций ПО и контролем эргономичности интерфейса. Вместе с этими задачами технический писатель занят изучением предметной области, проблемы которой решает программа. Все это позволяет значительно повысить и полезность сотрудника, и его квалифицированность.

Группа по выпуску типовых решений работает почти год. Главный итог ее работы - двухсот страничное руководство пользователя к программе «АБ: Строительные материалы 7.7.» Весьма специфическая функциональность конфигурации потребовала скрупулезной работы группы и по отладке программы, и по его описанию. Это было серьезное испытание, которое судя по всему пройдено успешно: конфигурация «АБ: Строительные материалы 7.7» протестирована в фирме «» и получила сертификат Совместимо! Система программ 1С: Предприятие. Сейчас в работе находятся еще 3 конфигурации.

Учитывая сложность проблемы и отсутствие какой-либо систематизированной информации по методологии создания технической документации для ПО, трудно переоценить важность редких попыток, направленных на развитие профессии технического писателя.
Семинары для технических писателей компании Philosoft скоро будут называть традиционными. Кроме собственно выступлений и докладов, подготовленных сотрудниками фирм с опытом создания технической документации, семинары ценны непосредственным общением специалистов, что, несомненно, положительно сказывается на развитии технического писательства в России. Тезисы докладов всегда можно найти на сайте компании Philosoft, а вот для обмена мнениями полезно присутствовать на семинарах вживую, тем более что для представителей компьютерных компаний вход бесплатный.
На последнем семинаре 22 июня был представлен ряд докладов, подготовленных сотрудниками компаний «1С-Рарус», «ОАО ТАНТК им. Г. М. Бериева» и компании «ПРОМТ». Обсуждались возможности применения программы Adobe FrameMaker 6.0 в работе технического писателя. Использование этого программного пакета в России стало возможным после его адаптации к кириллическим шрифтам. Тут же были отмечены его преимущества:
- мощные средства автоматизации вёрстки;
- возможность содержания большого руководства в группе файлов, составляющих единую книгу;
- единообразие оформления посредством шаблонов, описывающих практически все аспекты оформления руководства - формат страниц, содержимое колонтитулов, представление таблиц, уравнивания, методы нумерации;
- поддержка перекрёстных ссылок, исключающих дублирование материала руководства;
- автоматическое формирование оглавлений, указателя терминов, списка иллюстраций и подобного справочного материала.

От себя добавлю, что этот замечательный продукт достаточно дорог, хотя и предоставляет возможности оперативной работы с большими объёмами сопроводительной документации. Так что на сегодняшний день основным инструментом технического писателя остаётся MS Word.

Вниманию слушателей были представлены возможности использования программы Adobe FrameMaker с SGML для подготовки технических публикаций, а в заключение семинара состоялась презентация новой программы PROMT TerM - специализированного средства для автоматического извлечения и обработки терминологии.

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

Так что, очень хочется поблагодарить компанию Philosoft и лично Елену Меринову за организованный семинар, а, обращаясь ко всем, кто трудится на ниве технического писательства, хочется сказать: давайте общаться и развиваться на пользу наших потребителей.

Нужна помощь в выборе решения для вашего бизнеса? Звоните: (495) 988-08-20


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

Бесплатно проконсультироваться, уточнить цены и заказать решение можно у специалистов «1С-Архитектор бизнеса» по телефону или через форму обратной связи.

Cookie-файлы

На сайте https://www.1ab.ru/ используются cookie-файлы и другие аналогичные технологии. Если прочитав это сообщение, вы останетесь на нашем сайте, это означает, что вы не возражаете против использования этих технологий.