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

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

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

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

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

 

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

 

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

 

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

 

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

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

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

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

 

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

Последние статьи

Поиск в WebHelp находит удаленные раздел…

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

Читать полностью...

Контекстная справка в приложениях Window…

Понятие контекстной или контекстно-зависимой справки (от англ. context-sensitive help) появилось в 1987 году с выходом формата WinHelp. Изначально контекстная справка ...

Читать полностью...

Как поддерживать скриншоты в актуальном …

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

Читать полностью...

Перевод выходных документов в Help and M…

Выбрав русский язык и русскую кодировку в настройках проекта Help and Manual, многие авторы после первой сборки удивляются, увидев в выходных документах английские сло...

Читать полностью...

Размер и расположение окна CHM при перво…

Разработчик справки в формате CHM может задать размер и расположение окна, которые будут использоваться при первом запуске CHM-файла. После того, как пользователь пере...

Читать полностью...

Рваные края скриншотов в Help and Manual…

Многие платные редакторы скриншотов, например, SnagIt, FastStone Capture и др., умеют создавать эффект рваных краев. В сети Интернет можно найти множество видеоуроков ...

Читать полностью...
новое в Help and Manual 9

Новое в Help and Manual 9

23 ноября 2022 года компания EC Software к 25-летнему юбилею выпустила 9-ю версию программного комплекса Help and Manual (выходит c 1997 года). Комплект шаблонов Premi...

Читать полностью...

Создание CHM-справки в бесплатной програ…

KEL CHM Creator — это «новая» хорошо забытая программа, выпущенная в 2012 году, предназначенная для создания и декомпиляции CHM-файлов. Программа не требовательна к ре...

Читать полностью...

KEL CHM Creator — бесплатная программа д…

Если вам нужно создать CHM-файл, и вы больше не хотите пользоваться глючной программой HTML Help Workshop, тогда KEL CHM Creator — это ваш вариант. Программа позволяет...

Читать полностью...
ключевые слова

Ключевые слова в Help+Manual…

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

Читать полностью...

HTML Help Workshop – бесплатная программ…

В 1997 году Microsoft выпустила новый формат справки, HTML Help (CHM), а также бесплатную программу для создания и редактирования справки в этом формате — HTML Help Wo...

Читать полностью...

HelpNDoc — бесплатная альтернатива Help+…

Еще одной альтернативой RoboHelp и Help&Manual является программа HelpNDoc от французского разработчика, компании IBE Software. Это практически полный аналог HelpS...

Читать полностью...

HelpSmith — достойная альтернатива Help+…

Продолжая тему средств разработки справки и пользовательской документации, нельзя не рассказать о программе HelpSmith. Она работает по принципу единого источника и под...

Читать полностью...
отечественная программа для разработки справки

Dr.Explain — отечественная программа для…

За почти 30-летнюю историю существования RoboHelp и Help&Manual стали стандартом средств разработки справки и пользовательской документации в среде Windows. Сегодн...

Читать полностью...
вычитка текста

Как вычитать свой текст: инструкция для …

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

Читать полностью...
качество текста

Как повысить качество текста инструкций…

Каждый автор знает: во время написания и правки текста глаз замыливается. Смотришь в текст и читаешь не то, что написано, а то, что хочешь видеть. В этой статье я расс...

Читать полностью...

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

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

© Илья Жуков, 2019-2023. Охраняется законом об авторском праве.