Блог технического писателя Ильи Жукова

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

Уважаемые коллеги! Если вам нужно быстро освоить разработку документации по ГОСТ, рекомендую обратить внимание на книгу В.А. Глаголева «Разработка технической документации: руководство для технических писателей и локализаторов ПО». Это компактный справочник, который позволит быстро разобраться в НИОКР, ГСИ, ЕСКД, ЕСПД, ЕСТД, КСАС и начать применять полученные знания на практике.

В 2007 – 2008 годах в компании «Софтэнергоатом» я разрабатывал документацию по ГОСТ. Это были концепции, технические задания, эскизный и технический проекты, ПМИ и другая документация. Тогда быстро понять специфику работы по ГОСТ мне помог семинар компании «Философт» «Документирование автоматизированных систем в соответствии с требованиями ГОСТ серии 34». Полученный набор шаблонов и пустографок я использую и сегодня, когда возникает необходимость оформить документацию по ГОСТ.

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

 

распечатки ГОСТов

 

Книга В.А. Глаголева «Разработка технической документации» решила сразу несколько проблем: освободила место на моем рабочем столе и сделала мою сумку легче на несколько килограммов.

 

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

 

А теперь серьезно: что дала мне книга В.А. Глаголева «Разработка технической документации»?

Во-первых, книга позволила взглянуть на систему стандартов в целом. Считается, что чтобы понять систему, нужно выйти за ее пределы. Книга Вадима Глаголева позволила посмотреть на систему государственных стандартов со стороны, извне, понять взаимосвязь стандартов, а также место ГОСТов 19 и 34 в этой системе.

Во-вторых, любая печатная книга — это фундаментальный источник информации. Коллеги меня часто спрашивают «Ты это сам придумал или откуда-то взял?». Печатная версия книги позволяет ответить на этот вопрос предметно. Не просто упомянуть – это есть в ГОСТе. А открыть книгу и показать страницу с первоисточником.

В-третьих, хотелось бы отдельно отметить раздел про перевод, локализацию и редактирование технической документации. Несмотря на то, что книга не касается вопросов языковой стороны технической документации (стилистика, лексика и т.д.), рекомендации автора переводчикам и редакторам переводов технической документации необходимо в обязательном порядке включить в программу обучения филологов по специальности «Перевод и переводоведение».

 

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

Все о справке и документации для пользователей!

Следить за новыми статьями: