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

 obmen_soobsheniyami.png Чат для технических писателей 
 Зарегистрируйтесь
Страницы: 1
RSS
Концептуальный вопрос
 
На новом месте работы дали задание сварганить "описалово" на несколько программ. Фирма разрабатывет аппаратно-программыне комплексы АСУТП.  Собственно, нужно было создать набор документов из серии "эксплуатационная документация". Всю жизнь опираюсь на ЕСПД. Понял, что в первую очередь нужно на каждую из программ написать по руководству оператора (пользователя).

Написал, но теперь задался концептуальным вопросом.
Предварю немного, что за программы. Это набор из 3-х программ тима SCADA (самописная, не забугорная). 1) редактор мнемосхем, 2) редактор базы данных 3) АРМ диспетчера.

С др. стороны, эти прогрпаммы используются для выполнения отдельного проекта АСУТП: набор мнемосхем, база данных,... И уже результат этой работы сдаётся заказчику. И документация готовится на него.

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

Теперь я понял все так.
- На каждую из программ-инструментов можно изготовить по набору документации (РО, рук. программиста, системного программиста, администартора и т.п., и текст программ в том числе). Это по "ГОСТ 19." (ЕСПД).
- также и на весь проект готовится набор документов (по ЕСКД, РД). И туда включаются или часть написанных мною документов на отдельные программы (только РО, системного программиста минус тексты программ). Или же для конечного проекта нужно, ориентируясь на требования ЕСКД+РД (а уже не ЕСПД) переписать созданные мною документы и добавить недостающие.

PS. Программист против включения в документацию текста программы. Его "отмазки" -- если мы используем VisualStudio, никому же не приходит в голову требовать и исходные тексты на компиляторы.

Хотелось бы понять, правильно или не правильно пониамю эту тему я. Ну и какого-то обсуждения и примеров из собственной практики.
 
Цитата

PS. Программист против включения в документацию текста программы. .
Я не понял сути вопроса, те вся проблема в том,  что программист не хочет включать код программы в документ, а вы хотите понять включать его или нет? Правильно?
Работаю по-старинке...
 
Цитата
вся проблема в том,  что программист не хочет включать код программы в документ, а вы хотите понять включать его или нет? Правильно?
Это только один из вопросов, что встали передо мною.

Главное, что нужно для отдавать заказчику? Т.е. включить в конечный набор документов на сдаваемую АСУ?
- или 3 полных набора на каждую из программ (ЕСПД) + 1 набор на весь комплекс АСУ (ЕСКД, РД)?
- 1 набор на весь комплекс АСУ (ЕСКД, РД)?

Я уже склоняюсь ко 2-му варианту. Он проще.
Или я как-то "заблудился в 3х соснах"?  :(

Да, вопрос со включением текста программ тоже имеется, но он не критичен, просто понять хочется, как правильно. Наверное нужно обращаться в требованиям (которых у меня нет)....
 
А зачем заказчику текст программ?
Он САМ будет их переписывать-переделывать-исправлять?
И (почему бы и нет?) поменяет в эксплуатации?
Т.е. на ком лежит сопровождение в эксплуатации и кто отвечает за правильную работу? В том числе и после изменений?

Начальник должен решать. Тот, который подписывает документы о передаче в эксплуатацию  Вашего продукта.
Страницы: 1
Читают тему