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

 obmen_soobsheniyami.png Чат для технических писателей 
 Зарегистрируйтесь
Страницы: 1
RSS
Предложили составить регламент разработки технической документации, пытаемся систематизировать все знания о том, как составить регламент по разработке технической документации
 
Не пойму , что это за документ такой? Может "Методика разработки технической документации" но речь шла скорее всего о самом процессе разработки.
 
Процесс разработки технической документации подробно описан в стандарте ISO/IEC 26514-2008 Systems and software engineering — Requirements for designers and developers of user documentation.

Процесс управления разработкой технической документации описан в стандарте ISO/IEC/IEEE 26511-2011 Systems and software engineering — Requirements for managers of user documentation

Применительно к языку родных осин, надо добавить еще торжественные обещания следовать ГОСТам.
 
Цитата
writer пишет:
Не пойму , что это за документ такой? Может "Методика разработки технической документации" но речь шла скорее всего о самом процессе разработки.
Я писала такой документ несколько раз. В нем описывала сам процесс разработки документации, его участников, их роли, порядок взаимодействия и пр. Регламент подписывался руководителем и распространялся всем участникам.
techwriter.ru.com
 
Цитата
techwriter пишет:
Я писала такой документ несколько раз. В нем описывала сам процесс разработки документации, его участников, их роли, порядок взаимодействия и пр. Регламент подписывался руководителем и распространялся всем участникам.
А есть образец? :oops:
 
Цитата
writer пишет:
Цитата
techwriter пишет:
Я писала такой документ несколько раз. В нем описывала сам процесс разработки документации, его участников, их роли, порядок взаимодействия и пр. Регламент подписывался руководителем и распространялся всем участникам.
А есть образец?  :oops:
Ох, все там осталось. Но могу написать структуру, которую он содержал ;)
techwriter.ru.com
 
Цитата
techwriter пишет:
Цитата
Ох, все там осталось. Но могу написать структуру, которую он содержал  ;)
очень жаль  :cry: .... Если можно, то вышлите структуру, уже будет начало положено)
 
Цитата
Виктор Фигурнов пишет:
ISO/IEC 26514-2008 Systems and software engineering — Requirements for designers and developers of user documentation.
Виктор, а у вас есть эти стандарты?
 
Цитата
techwriter пишет:
Цитата
описывала сам процесс разработки документации, его участников, их роли, порядок взаимодействия и пр.
Кроме этого, хорошо бы описать ещё процедуры:
-- определения целей, аудитории, задач разработки документации
-- активации проекта документирования,
-- создания плана документирования и плана управления документированием,
-- создания и утверждения спецификаций стилей документирования
-- управления документированием
Структуру декомпозиции работ
Инфраструктуру документирования
Методы и процедуры контроля качества и производительности документирования.

Видимо, такой документ должен основываться также на положениях  п.п. 7.2.1 и 6.3.6 стандарта ISO/IEC 12207:2008 ( ГОСТ Р ИСО/МЭК 12207-2010 "Информационная технология. Системная и программная инженерия. Процессы жизненного цикла программных средств" )
 
Цитата
writer пишет:
Цитата
Виктор Фигурнов пишет:
ISO/IEC 26514-2008 Systems and software engineering — Requirements for designers and developers of user documentation.
Виктор, а у вас есть эти стандарты?
Да. Пришлось купить. :)
 
Мда
Цитата
Виктор Фигурнов пишет:
Цитата
techwriter пишет:
Цитата
описывала сам процесс разработки документации, его участников, их роли, порядок взаимодействия и пр.
Кроме этого, хорошо бы описать ещё процедуры:
-- определения целей, аудитории, задач разработки документации
-- активации проекта документирования,
-- создания плана документирования и плана управления документированием,
-- создания и утверждения спецификаций стилей документирования
-- управления документированием
Структуру декомпозиции работ
Инфраструктуру документирования
Методы и процедуры контроля качества и производительности документирования.

Видимо, такой документ должен основываться также на положениях п.п. 7.2.1 и 6.3.6 стандарта ISO/IEC 12207:2008 ( ГОСТ Р ИСО/МЭК 12207-2010 "Информационная технология. Системная и программная инженерия. Процессы жизненного цикла программных средств" )
Мда уж..., а мне завтра его сдавать нужно))
Коллеги, спасайте!! Буду премного благодарен!
 
Цитата
Виктор Фигурнов пишет:
Цитата
writer пишет:
Цитата
Виктор Фигурнов пишет:
ISO/IEC 26514-2008 Systems and software engineering — Requirements for designers and developers of user documentation.
Виктор, а у вас есть эти стандарты?
Да. Пришлось купить.  :)
поделитесь?)) английская версия?
 
Цитата
writer пишет:
Цитата
techwriter пишет:
Цитата
Ох, все там осталось. Но могу написать структуру, которую он содержал  ;)  
очень жаль  :cry:  .... Если можно, то вышлите структуру, уже будет начало положено)
Структура была такой:
1. Общие сведения.
В разделе перечислялись общие сведения о документе - его назначение и кому он адресован, что он регламентирует и различные ограничения по его применению.
2. Описание процесса документирования.
В разделе приводилась диаграмма процесса документирования в IDEF0.
3. Роли и функции участников процесса документирования.
4. Стадии создания документации.
Описывались стадии создания документации: какие работы проводятся и кем. Кто какую ответственность несет.
techwriter.ru.com
 
Спасибо всем за помощь, я полностью теперь погружен в процесс.. beach-smile
 
а это что?
Цитата

В разделе приводилась диаграмма процесса документирования в IDEF0.
 
Цитата
writer пишет:
а это что?
Диаграмма для описания бизнес-процессов.
techwriter.ru.com
 
ага понятно, спасибо
Страницы: 1
Читают тему