Технический писатель - секреты профессионального успеха.

Удаленная работа для технических писателей!

Документирование по правилам. Чужие ГОСТы или свои Корпоративные стандарты?

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

О Гостах

Думаю, что многие меня поддержат если скажу, что время ГОСТов прошло. Прошло оно быстро и думаю, что бесповоротно. Сейчас, наверное, только компании работающие по гос заказу стараются придерживаться ГОСТов. А ведь с каждым годом делать это становится все сложнее и сложнее. Да, они обновляются! Да, в них можно найти полезную информацию! Но, тот, кто хоть раз пытался найти что-то конкретное по оформлению документации в ГОСТах меня поймет. К тому же, ГОСТы очень устарели и потеряли свою актуальность. Вот взять хотя бы пару пунктов из ГОСТов: «Опечатки, описки и графические неточности, обнаруженные в процессе выполнения документа, допускается исправлять подчисткой или закрашиванием белой краской и нанесением на том же месте исправленного текста (графика) машинописным способом или черными чернилами, пастой или тушью рукописным способом». (ГОСТ 2.105-95 п. 3.7) Вот этот пример мне особенно нравится: «Абзацы в тексте начинают отступом, равным пяти ударам пишущей машинки (15 - 17 мм)». (ГОСТ 2.105-95 п. 3.6)

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

О корпоративных стандартах

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

Что должно входить во внутренний стандарт?

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

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

Стиль	Использование	Пример
Code	Названия функций, Операции в коммандной строке, Условные выражения	-s16 If Qualifier 1 equals FX, then assign the value..
Heading 1	Заголовки статей	Topic Title
Heading 2	Заголовки втрого уровня	Second Level Heading
Heading 3	Заголовки третьего уровня	Third Level Heading

Форматирование рисунков. Если вы используете одну программу для графики, то проще всего в этот раздел стандарта просто записать все эффекты, которые вы применяете для картинок, а так же размер скрин шотов, которого нужно стараться придерживаться.

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

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

Анна Кулешова

01.07.2009, 75 просмотров.

Атрибуты элемента инфосистемы

Автор
E-mail

Курсы технических
писателей

Разработка
контента для сайта

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

"Говорящие"
техписы

Идем на Форум!

Новости

02.12.2011 13:06:01

20 декабря 2011 года Курсы для технических писателей в Москве

20 декабря 2011 года в Москве пройдет последний в этом году обучающий курс для технических писателей:"Профессия: Технический писатель. Разработка технической документации от А до Я".

Программу курса и порядок регистрации на семинар вы можете посмотреть здесь

RSS

Архив "Новости"

Биосфера для техписа

Что окружает технического писателя, вдали от ТЗ, ГОСТов, Help. Какие существуют сообщества авторов в окружающем мире?...

18.04.2011 12:15:13

Как полгода пользоваться MS Office 2010 бесплатно?

Недавно корпорация Microsoft объявила о начале продаж нового пакета программ Office 2010 по всему миру, включая Россию и страны СНГ. Эксперты очень высоко оценивают новые возможности хорошо знакомых программ Word и Excel, но пока сомневаются в том, что они подвигнут бизнес и население к массовому отказу от старых версий. Многие пользователи так и не перешли с версии 2003 на 2007 офиса.

18.03.2010 18:39:39

Текст по правилам

Программа предназначена для форматирования текстовых документов по задаваемым правилам.

20.10.2009 16:17:35

Конференция Поддержки Пользователей в Кардиффе

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

конференции технических писателей

RSS

Архив "Биосфера для техписа"

Сайт технических писателей

По всем вопросам обращайтесь в TechWriters.ru

Адрес: 107996, Москва, К-31, ГСП-6, Кузнецкий мост, 12, Государственная публичная научно-техническая библиотека России.

Телефон: все контакты до 1 марта 2012 осуществляются только по e-mail: info @techwriters.ru (без пробелов)

О возможных ошибках на сайте сообщайте admin @ techwriters.ru. Спасибо.

CMS

РЕКЛАМА Карты WebMoney WMZ, WME, WMR - пополнение webmoney. WM-карты с доставкой по Москве. . Компьютерные столы - мебель минимализм.

Курсы. Семинары. Тренинги.