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

В современном IТ-производстве все большее число компаний старается стандартизировать свою деятельность. Еще лет 15 назад программисты российских IT – компаний писали программы, полагаясь только на свой личный опыт, часто не задумываясь о том, как написаны программы их коллегами, сидящими в соседней комнате. Выяснилось, что программист тратит много времени на такие простые операции, как придумывание названий функций, констант, переменных, полей базы данных и пр. Причем, если программист увольняется из компании, то его коллеги начинают ломать голову, что же содержится в поле БУХАНАЛ и ПРОВЧЕРБУХ? Это далеко не единственная проблема, возникающая от отсутствия корпоративных стандартов.


В документировании дела обстояли еще хуже. Документы в одной и той же компании писали в разных форматах, про стиль изложения вообще мало кто думал. Общее настроение программистов по отношению к документированию определялось мнением – документацию писать дело весьма неинтересное и недостойное. Спасательным кругом в такой ситуации был ГОСТ, который сегодня безнадежно устарел.

Сейчас крупные IТ-компании пытаются стандартизировать процесс документирования. Стандарты строятся на основе опыта самих технических писателей и существующей литературы. В этой связи представляет интерес книга, которая может стать великолепной основой для создания корпоративных стандартов документирования и доступна в Интернет. Это книга “Writing Revisible Manuals A Handbook for Business and Government”, выпущенная компанией Duncan Kent & Associates Ltd. Книга содержит рекомендации по всем этапам производства печатной документации – от создания макетов руководств и основ представления информации до описания фотонаборных установок. Книга особенно подходит для технических писателей, которые создают свои документы на английском языке, так как содержит стилистические рекомендации по оптимизации англоязычных текстов.

Для тех, кто пишет на английском, можно порекомендовать еще один ресурс:

Writing Styleguide and Dictionary of Plain English от той же компании Duncan Kent &Associates Ltd.

Эта книга полностью посвящена стилистической оптимизации технических текстов.

В российском Интернете таких ярких книг, как “Writing Revisible Manuals – A Handbook for Business and Government” очень мало, а может быть и вообще нет. Во всяком случае обнаружить их не удалось. Самым известным ресурсом для технических писателей бесспорно является компании PhiloSoft Technical Communications. Что полезного на этом сайте? Есть достаточно объемная книга “MetaGuide”, которая может также оказаться полезной при создании корпоративных стандартов документирования. Пожалуй, наиболее ценным разделом сайта Philosoft является его Форум. Форум создан относительно недавно, но быстро разрастается. Форум имеет следующие разделы:

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

* Языки разметки как инструмент писателя.

* Вселенная FrameMaker.

* Технические средства перевода.

* Ресурсы для технических писателей и переводчиков.

* Тестирование ПО.

Следующая группа ресурсов посвящена основам верстки печатных изданий. Хочется отметить книгу Николая Волкова “Курс макетирования и верстки “. Если информации, содержащейся в этой книге, вам окажется недостаточно, то вы найдете исчерпывающие сведения о верстке и полиграфической культуре печатных изданий в книге А. Э. Мильчина и Л. К. Чельцовой “Справочник издателя и автора. Редакционно-издательское оформление издания”.

Что касается методов составления технической документации, то можно отметить две небольших, но интересных статьи: статья Вильяма Раиса “Writing User Manuals from the Middle Out” и статья Нэнси Халлиган “A Short Course on Writing Technical Reports”. Вильям Раис в своей статье описывает интересный подход к составлению документации, схожий с эффектом снежного кома, где автор рекомендует писать документацию не линейно, а наметить ключевые точки и как бы оборачивать их информацией. Нэнси Халлиган приводит распространенные проблемы написания технических текстов и показывает, как эти проблемы могут быть разрешены.

Теперь относительно сайтов, посвященных созданию технологии документирования на основе XML и SGML. Ресурсы ХМL-технологии обсуждаются также на форуме компании Philosoft в разделе Языки разметки как инструмент писателя.

В заключение хотелось бы упомянуть компании-производители инструментов технических писателей. Это компания Adobe Systems, являющаяся производителем таких важных для технического писателя продуктов, как PageMaker, FrameMaker и Acrobat, корпорация eHelp – производитель RoboHELP – одного из известнейших продуктов для создания справок.
Большой интерес представляет раздел Форум в русскоязычном ресурсе.

Это, пожалуй, все ресурсы, которые удалось найти. Если кому-то из читателей известны какие-либо еще интересные ресурсы, присылайте ссылки на них по адресу [email protected] ru и они обязательно будут опубликованы в следующих обзорах.

0 ответы

Ответить

Хотите присоединиться к обсуждению?
Не стесняйтесь вносить свой вклад!

Добавить комментарий