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

 obmen_soobsheniyami.png Чат для технических писателей 
 Зарегистрируйтесь
Страницы: 1
Ответить
RSS
Вид документации, К каому виду относится документация на разработку АС
 
Здравствуйте.
Не так давно осваиваю данную специальность. Прочитала госты, темы на форуме..но единообразия не пришло.

Из прочитанного пришла к выводу, что техническая документация разделяется на:
  • технологическая
  • проектная
  • эксплуатационная
Или гуру профессии, поправьте меня!
Вот список документов, что куда отнести?

Акт о результатах опытной эксплуатации ППО;
Акт о результатах тестовой эксплуатации ППО;
Акт об итогах опытной эксплуатации ППО;
Ведомость технических документов;
Ведомость эксплутационных документов;
Документированные исходные коды ППО;
Дополнение к пояснительной записке;
Инструкции администратора/по установке и настройке/по эксплуатации ППО;
Обучающие видео материалы;
Описание информационной базы/ПО;
Перечень входных и выходных сигналов;
ПМИ;
Пояснительная записка к техническому проекту;
Программа опытной эксплуатации;
Протокол предварительных/приемочных/комплексных испытаний ППО;
Регламент работ по обслуживанию;
Реестр запросов на изменения и разработку новой функциональности;
Реестр изменений;
Руководства оператора/пользователя/администратора/оператора ППО;
Технические акты сдачи-приемки выполненных по этапу работ;
Техническое задание/Частное техническое задание;
Формуляр;
Эксплуатационная документация ППО.
 
По ГОСТ 34.201 документация:
  • конструкторская (ЕСКД, ГОСТ 2.102)
  • программная (ЕСПД, ГОСТ 19.101).
Отдельно существует также технологическая (ЕСТД, ГОСТ 3.1102-2011).

Конструкторская документация:
  • Технологическая (разработка, изготовление, контроль, приемка, ГОСТ 2.102-68-2001);
  • Эксплуатационная (использование при эксплуатации, обслуживание и ремонт в процессе эксплуатации, ГОСТ 2.601-2006);
  • Ремонтная (ремонтные работы на специализированных предприятиях, ГОСТ 2.602-95).
Отдельно в конструкторской документации по способу выполнения выделяют:
  • Документы на ЭВМ (на бумажных носителях, выполненных с помощью АЦПУ или на графических устройствах вывода, ГОСТ 2.004-88);
  • Электронные документы (ГОСТ 2.051-2006);
  • Схемы (ГОСТ 2.701-2008).
Так.... понял... Тут можно еще долго расписывать, поэтому про программные и технологические документы не буду - хватит ссылок на ГОСТы. А чтобы не путаться, следует принять несколько простых правил:
  1. Акты, технические акты, реестры - дополнительная документация к проектной, эксплуатационной и т.д. хотя таковой не считается, может считаться проектной (при указании в ТЗ) и организационно-распорядительной;
  2. Ведомость, руководство, инструкция - ищем ключевые слова ("... технических документов" - технологическая документация, "... эксплуатационных ..." - эксплуатационная и т.д.);
  3. Дополнение - считать такого рода документом, что и основной;
  4. Документы, названия которых присутствуют в ГОСТ 2.102-68-2001, 19-101-77, 3.1102-2011 и РД 50-34.698-90, не подпадающие под вышеуказанные правила - проектные, указаны в стадиях разработки соответствующих ГОСТов;
  5. Документы, не подпадающие под вышеуказанные правила считать прочими, т.е. дополнительными, информационными, рекламными, коммерческими, организационно-распорядительными и т.д.
Любой проектный документ может быть эксплуатационным, технологическим или программным. Все зависит от того, согласно какого ГОСТ, ГОСТ Р или РД выполняется.
Классифицировать какой-либо документ необязательно, необходимость составления документа определяется совместно с заказчиком на этапе разработки и утверждения технического задания, если данный документ не является обязательным (обязательность документа определяется по таблице стадий разработки в выбранном ГОСТ - стандарт "Виды ... документов").

Согласно всего вышесказанного Ваш список может принять следующий вид:

Акт о результатах опытной эксплуатации ППО; ОР+Э
Акт о результатах тестовой эксплуатации ППО; ОР+Э
Акт об итогах опытной эксплуатации ППО; ОР+Э
Ведомость технических документов; Т/Пр
Ведомость эксплутационных документов; Пр+Э
Документированные исходные коды ППО; Пр-Э
Дополнение к пояснительной записке; Пр+Э
Инструкции администратора/по установке и настройке/по эксплуатации ППО; Э
Обучающие видео материалы; Э+Д
Описание информационной базы/ПО; Пр+Э
Перечень входных и выходных сигналов; Пр
ПМИ; Пр
Пояснительная записка к техническому проекту; Пр
Программа опытной эксплуатации; Пр
Протокол предварительных/приемочных/комплексных испытаний ППО; Пр
Регламент работ по обслуживанию; Э
Реестр запросов на изменения и разработку новой функциональности; ОР
Реестр изменений; ОР+Э
Руководства оператора/пользователя/администратора/оператора ППО; Э
Технические акты сдачи-приемки выполненных по этапу работ; ОР
Техническое задание/Частное техническое задание; Пр
Формуляр; Пр
Эксплуатационная документация ППО. Пр+Э

где:
Пр - проектная;
ОР - организационно-распорядительная;
Э - эксплуатационная;
П - программная;
К - конструкторская;
Т - техническая (необходимо относить к конструкторской К или программной П, например Т/К или Пр+Т/П);
Д - прочие документы.

P.S.: Примеры расшифровки:
Пр+Э/П - эксплуатационный программный документ по проекту;
Т/К - технический или конструкторский документ;
ОР+Э - организационно-распорядительный документ эксплуатационной документации.

P.P.S.: Данное представление классификации считать сугубо личным мнением автора.
Изменено: H&M User - 26.08.2015 17:18:21
 
Цитата
Ovin написал:
Здравствуйте.
Не так давно осваиваю данную специальность. Прочитала госты, темы на форуме..но единообразия не пришло.

Из прочитанного пришла к выводу, что техническая документация разделяется на:
 технологическая
 проектная
 эксплуатационная
Иногда выделяются и другие виды документации. Например, по рекомендациям Р 50-605-80-93 техническая документация на военную технику подразделяется на нормативно-техническую, конструкторскую, технологическую и программную.

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

См., например, стандарты:
  • ISO/IEC 15288:2015 — Процессы жизненного цикла систем,
  • ISO/IEC 12207:2008 — Процессы жизненного цикла информационных систем,
  • ISO/IEC 20000-1:2011, ISO/IEC 20000-2:2012 — Процессы жизненного цикла услуг,
  • ISO/IEC/IEEE 15289:2015 — Содержание информационных продуктов процесса жизненного цикла систем и программного обеспечения (документация).
Стандартом ISO/IEC/IEEE 15289:2015 "Содержание информационных продуктов процесса жизненного цикла систем и программного обеспечения (документация)" предусмотрены следующие виды документации:

Спецификация
  1. Договор
  2. Сервисное соглашение
  3. Техническое задание на программу
  4. Техническое задание на систему (или сервис)
  5. Требования к валидационному тестированию
Описание
  1. Концепция деятельности
  2. Описание архитектуры системы
  3. Описание дизайна базы данных
  4. Описание дизайна программной системы
  5. Описание интерфейса
  6. Описание программной архитектуры
  7. Описание программной единицы
  8. Описание элемента системы
  9. Предложение
  10. Служебный каталог
Отчет
  1. Отчет о валидации
  2. Отчет о верификации
  3. Отчет о выполнении работ
  4. Отчет о квалификационном испытании
  5. Отчет о мониторинге и контроле
  6. Отчет о признании аудита
  7. Отчет о проведении приемочной проверки и тестирования
  8. Отчет о состоянии конфигурации
  9. Отчет о тестировании программной единицы
  10. Отчет об анализе возможностей улучшения
  11. Отчет об аудите
  12. Отчет об инсталляции
  13. Отчет об интеграции и тестировании
  14. Отчет об инциденте
  15. Отчет об обнаруженных проблемах
  16. Отчет об оценке
  17. Оповещение пользователя
  18. Оценка необходимости продукта
  19. Протокол обзора
  20. Сервисный отчет
План
  1. План аудита
  2. План валидации
  3. План верификации
  4. План вывода из эксплуатации
  5. План выпуска
  6. План документирования
  7. План измерений
  8. План инсталляции
  9. План интеграции
  10. План обеспечения информационной безопасности
  11. План обеспечения мощности
  12. План обеспечения непрерывности и доступности сервиса
  13. План обучения
  14. План повторного использования
  15. План приемки
  16. План приобретения
  17. План развития
  18. План сопровождения
  19. План улучшений
  20. План управления активами
  21. План управления информацией
  22. План управления качеством
  23. План управления конфигурацией
  24. План управления проектом
  25. План управления рисками
  26. План управления сервисом
  27. Инженерный план домена
  28. Сервисный план
Политика
  1. Политика управления конфигурацией
  2. Политика бюджетирования и учета
  3. Политика выпуска
  4. Политика жизненного цикла системы
  5. Политика обеспечения информационной безопасности
  6. Политика управления качеством
  7. Политика управления конфигурацией
  8. Политика управления рисками
  9. Политика управления услугами
Процедура
  1. Пользовательская документация
  2. Учебная документация
  3. Процедура взаимодействия
  4. Процедура представления жалоб
  5. Процедура аудита
  6. Процедура выбора поставщика
  7. Процедура документирования
  8. Процедуры жизненного цикла системы
  9. Процедура квалификационного испытания
  10. Процедура обеспечения информационной безопасности
  11. Процедура осуществления
  12. Процедура оценки процессов
  13. Процедура разрешения проблем
  14. Процедуры сопровождения
  15. Процедура тестирования программной единицы
  16. Процедура улучшений
  17. Процедура управления информацией
  18. Процедура управления инцидентами
  19. Процедура управления конфигурацией
  20. Процедуры управления мощностью
  21. Процедура управления поставщиками
  22. Процедуры эксплуатационного тестирования
Запрос
  1. Запрос действий, связанных с рисками
  2. Запрос на изменение
  3. Запрос на предложения
  4. Запрос на ресурсы
  5. Исследование удовлетворенности клиентов
Там же описано соответствие этих видов документации и видов процессов жизненного цикла систем, программного обеспечения и сервисов.
Изменено: Виктор Фигурнов - 31.08.2015 16:50:22
 
Виктор, скажите, у Вас уже есть GOST R ISO 15289-20ХХ или это просто вольный перевод видов документации из ISO/IEC/IEEE 15289:2015?
Очень странно видеть в качестве спецификации договор и сервисное обслуживание. Насколько я помню, спецификацией можно считать только формализованное представление требований, предъявляемых к разрабатываемому продукту (+ условия, эффект действия, описание задачи), без указания способов достижения. Как смешать теплое с мягким?
А про заказчиков программной документации по ГОСТ 19 умолчу, для них спецификация это лишь список программных документов (19.202) :)
Будем надеяться, что к моменту перехода на новые стандарты ГОСТ Р ИСО, 19-е уже умрут...
 
Цитата
H&M User написал:
Виктор, скажите, у Вас уже есть GOST R ISO 15289-20ХХ или это просто вольный перевод видов документации из ISO/IEC/IEEE 15289:2015?
Такого ГОСТ нет, но юридический статус стандартов ISO и ГОСТ в Российской Федерации одинаков. Согласно закону РФ "О техническом регулировании", стандарты - это документы, в которых в целях добровольного многократного использования устанавливаются характеристики продукции, правила осуществления и характеристики процессов проектирования (включая изыскания), производства, строительства, монтажа, наладки, эксплуатации, хранения, перевозки, реализации и утилизации, выполнения работ или оказания услуг (ст. 2 Закона). К документам в области стандартизации, используемым на территории Российской Федерации, относятся как национальные стандарты, так и международные стандарты (ст. 13 Закона).

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

Цитата
H&M User написал:
Насколько я помню, спецификацией можно считать только формализованное представление требований, предъявляемых к разрабатываемому продукту (+ условия, эффект действия, описание задачи), без указания способов достижения.
Полагаю, что договор можно считать спецификацией прав и обязанностей сторон по поводу предмета договора.  :)

Цитата
H&M User написал:
А про заказчиков программной документации по ГОСТ 19 умолчу, для них спецификация это лишь список программных документов (19.202)
Русский язык, как и другие естественные языки, не отличается однозначностью. Многие слова имеют несколько значений. В словарях я нашел 6 разных значений слова "спецификация". Например: спецификация - не обусловленная договором переработка материала, в результате которого создается новая, иного рода вещь (не обусловленное договором изготовление стола из дерева и т.п.).; спецификация - перечисление подробностей, на которые необходимо обратить особое внимание...  :(

По тем же стандартам ГОСТ 19 пользователь - это организация-держатель дубликата.  hi-hi-hi  И что из этого?
Изменено: Виктор Фигурнов - 31.08.2015 18:58:55
 
Цитата
Виктор Фигурнов написал:
По тем же стандартам ГОСТ 19 пользователь - это организация-держатель дубликата.    И что из этого?
Ничего, зато из этого становится логически понятно, что организация-держатель оригинала - это разработчик или правообладатель :)
 
Добрый день! Готовясь к аттестации столкнулась с вопросом "Разница между руководством пользователя и руководством по эксплуатации?". Подскажите в чем разница?  
 
Как правило, Руководство пользователя идет к программному продукту, а Руководство по эксплуатации, на прибор, например, на телевизор или стиральную машину
 
Вполне могут быть (и бывают) Руководство пользователя автомобиля и Руководство по эксплуатации программы.

То есть не всегда Руководство пользователя относится к ПО, а Руководство по эксплуатации  к изделиям.

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

Например:

Руководство пользователя поиска Яндекса это может быть несколько страничек для конечного пользователя со сведениями, как составлять запросы на поиск, просматривать и уточнять результаты поиска.

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

Если ваше начальство или заказчики являются гостофилами, вас не убудет если Руководство пользователя или Руководство по эксплуатации сделаете с учетом требований подходящих ГОСТов. Например, Руководство по эксплуатации изделия машиностроения или приборостроения - с учетом ГОСТ 2.610-2006 "Правила выполнения эксплуатационных документов".
 
Цитата
H&M User написал:
Виктор, скажите, у Вас уже есть GOST R ISO 15289-20ХХ

Теперь появился такой ГОСТ: ГОСТ Р 56713-2015 (ISO/IEC/IEEE 15289:2011) "Системная и программная инженерия. Содержание информационных продуктов процесса жизненного цикла систем и программного обеспечения (документация)"

Утвержден и введен в действие Приказом Федерального агентства по техническому регулированию и метрологии от 16 ноября 2015 г. № 1820-ст
 
Виктор спасибо! Добавлю на сайт в ближайшее время.
Страницы: 1
Ответить
Читают тему
Форма ответов
 
Текст сообщения*
Загрузить файл или картинкуПеретащить с помощью Drag'n'drop
Перетащите файлы
Ничего не найдено
Загрузить файлы
Отправить Отменить