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

 obmen_soobsheniyami.png Чат для технических писателей 
 Зарегистрируйтесь
Страницы: 1
Ответить
RSS
Корпоративный стандарт (стиль) технической документации, как составить и что должен содержать документ "Корпоративный стандарт (стиль) технической документации"
 
Коллеги, вот и передо мной встала задача по разработке корпоративного стандарта документации для компании, раньше всегда приходил на "готовенькое"  ;)  . Подскажите, поделитесь, структурой документа , какие разделы должен содержать, есть ли у кого шаблон, или уже готовый документ, которым не жалко поделиться (переработаю "от" и "до"  ;)  ).
Разработка корпоративного стандарта, достаточно распространенная задача для технического писателя, поэтому , думаю, тема станет достаточно популярной
 
Я писала корпоративный стандарт целых 2 раза :))) Но все, опять же, осталось "там", поэтому поделиться ничем не могу, только описанием того, как я их разрабатывала. В теме поучаствую, т.к. возможно, мне тоже совсем скоро придется писать в связи с изменением "идеологии" разработки документации.
Рекомендую разделить стандарт на две части: на сам процесс и на правила разработки документации. В принципе, если есть регламент разработки, то первую часть составлять необязательно, т.к. она будет повторять регламент.
Во второй части я определяла следующее:
1. Правила комплектования документации.
2. Требования к структуре документов.
3. Требования к стилю изложения.
4. Требования к оформлению документации.
5. Требования к технологиям и средствам разработки документации.
6. Требования к формату документации.
7. Требования к хранению документации.
Требования должны быть очень детальными, если на выходе хочется получить единообразную документацию при условии, что разрабатывается она группой технических писателей. Я, например, прописывала все: вплоть до употребления буквы ё и использования вложенных кавычек.
Также следует иметь в виду, что стандарт порождает "дочерние" документы. У меня такими документами были: "Описание стилей", "Шаблонные описания", "Шаблоны документации", "Контрольные листы проверки документации" и пр.
techwriter.ru.com
 
Посмотрите имеющиеся корпоративные стандарты. Вот, например:

Cisco Technical Documentation Style Guide
http://www.cisco.com/c/dam/en/us/td/docs/general/style/guide/SGAug09/stylegd.pdf

SAE Technical Paper Style Guide
http://volunteers.sae.org/authors/styleguide.pdf
 
Можно добавить это:

1    ОБЩИЕ ПОЛОЖЕНИЯ    
1.1    Термины и определения    
1.2    Формулировка общей задачи    
2    РЕГИСТРАЦИЯ ДОКУМЕНТА В СИСТЕМЕ УЧЕТА    (формирование имени файла, выбор места хранения, порядок записи дисков с документами)
3    ОФОРМЛЕНИЕ ДОКУМЕНТА СОГЛАСНО ГОСТ    
3.1    Предписание ГОСТ ЕСКД к оформлению документа    
3.2    Предписание ГОСТ 34 серии к оформлению документа    
3.3    Предписание ГОСТ ЕСПД к оформлению документа    
3.4    Требования ГОСТ к электронным документам    
....
 
Коллеги, спасибо за ссылки и предложения, учту при разработке, а какой-нибудь готовый русскоязычный документ есть у кого-нибудь?
 
Есть
1) "РЕГЛАМЕНТ УЧЕТА ПРОГРАММНОГО ОБЕСПЕЧЕНИЯ"
2) "Положение о порядке регистрации и учёте проектов"
3) и собственные наработки.
Изменено: Andreyka - 18.08.2014 15:38:52 (прописались теги)
 
Цитата
Andreyka пишет:
Есть
1) "РЕГЛАМЕНТ УЧЕТА ПРОГРАММНОГО ОБЕСПЕЧЕНИЯ"
2) "Положение о порядке регистрации и учёте проектов"
3) и собственные наработки.
отписался в чате
 
Стандарты которые могут быть полезны при оформлении (создании) корпоративного стандарта:

1.1. ГОСТ 1.1-2002 Межгосударственная система стандартизации. Термины и определения.
1.2. ГОСТ Р 6.30-2003. Унифицированные системы документации. Унифицированная система организационно-распорядительной документации. Требования к оформлению документов.
1.3. ГОСТ Р 51141-98. Делопроизводство и архивное дело. Термины и определения.
1.4. ГОСТ Р ИСО МЕК 15910-2002 Информационная технология. Процесс создания документации пользователя программного средства.
1.5. ГОСТ Р ИСО 15489-2007 «Система стандартов по информации, библиотечному и издательскому делу. Управление документами. Общие требования».
1.6. ПР 45.02-97 Отраслевая система стандартизации. Принципы разработки нормативных документов.
Страницы: 1
Ответить
Читают тему
Форма ответов
 
Текст сообщения*
Загрузить файл или картинкуПеретащить с помощью Drag'n'drop
Перетащите файлы
Ничего не найдено
Загрузить картинки
Отправить Отменить