Изучение объекта (предмета) документирования

Смотрите:
Изучение объекта (предмета) документирования путем проведения предпроектного обследования
Уточнение объекта (предмета) документирования

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

Создан 18.10.2009 11:09:44

Изучение объекта (предмета) документирования - этап, предшествующий собственно разработке техдокументации. Прежде чем браться за документирование (и вообще за проект в целом), целесообразно со всей тщательностью изучить предмет разработки, что позволит при приемке-сдаче работы избежать недоразумений и исключить финансовые и временные потери.

- Изучение объекта (предмета) документирования

Изучение объекта (предмета) документирования путем проведения предпроектного обследования

Проведение предпроектного обследования - тема избитая, но стоит, все же, стряхнуть пыль с ГОСТ 34.601-90 и РД 50-34.698-90, освежить в памяти стадии и этапы работ, а также сведения о разрабатываемых в ходе их выполнения документах.

Стадии и этапы создания АС в общем случае приведены в таблице 1.

Стадии

Этапы работ

1 Формирование требований к АС

1.1 Обследование объекта и обоснование необходимости создания АС
1.2 Формирование требований пользователя к АС
1.3 Оформление отчета о выполненной работе и заявки на разработку АС (тактико-технического задания)

2 Разработка концепции АС

2.1 Изучение объекта
2.2 Проведение необходимых научно-исследовательских работ
2.3 Разработка вариантов концепции АС, удовлетворяющего требованиям пользователя
2.4 Оформление отчета о выполненной работе

3 Техническое задание

3.1 Разработка и утверждение технического задания на создание АС

4 Эскизный проект

4.1 Разработка предварительных проектных решений по системе и ее частям
4.2 Разработка документации на АС и ее части

5 Технический проект

5.1 Разработка проектных решений по системе и ее частям
5.2 Разработка документации на АС и ее части
5.3 Разработка и оформление документации на поставку изделий для комплектования АС и (или) технических требований (технических заданий) на их разработку
5.4 Разработка заданий на проектирование в смежных частях проекта объекта автоматизации

6 Рабочая документация

6.1 Разработка рабочей документации на систему и ее части
6.2 Разработка или адаптация программ

7 Ввод в действие

7.1 Подготовка объекта автоматизации к вводу АС в действие
7.2 Подготовка персонала
7.3 Комплектация АС поставляемыми изделиями (программными и техническими средствами, программно-техническими комплексами, информационными изделиями)
7.4 Строительно-монтажные работы
7.5 Пусконаладочные работы
7.6 Проведение предварительных испытаний
7.7 Проведение опытной эксплуатации
7.8 Проведение приемочных испытаний

8 Сопровождение АС

8.1 Выполнение работ в соответствии с гарантийными обязательствами
8.2 Послегарантийное обслуживание

[из п. 2.1 ГОСТ 34.601-90]

При проведении предпроектного обследования интерес представляет вторая стадия - «Разработка концепции АС» и соответствующие ей этапы работ.

На этапах 2.1 «Изучение объекта» и 2.2 «Проведение научно-исследовательских работ» организация-разработчик проводит детальное изучение объекта автоматизации и необходимые научно-исследовательские работы (НИР), связанные с поиском путей и оценкой возможности реализации требований пользователя, оформляют и утверждают отчеты о НИР [из п. 4 прил. 1 ГОСТ 34.601-90]

На этапе 2.3 «Разработка вариантов концепции АС и выбор варианта концепции АС, удовлетворяющего требованиям пользователя», в общем случае, проводят:

[из п. 5 прил. 1 ГОСТ 34.601-90]

этапе 2.4 «Оформление отчета о выполненной работе» подготавливают и оформляют отчет, содержащий описание выполненных работ на стадии описания и обоснования предлагаемого варианта концепции системы [из п. 6 прил. 1 ГОСТ 34.601-90]

На стадии разрабатывают отчет по ГОСТ 7.32 [из п. 2.1 прил. 1 РД 50-34.698-90]

В основной части отчета приводят:

  1. описание результатов изучения объекта автоматизации;
  2. описание и оценку преимуществ и недостатков разработанных альтернативных вариантов концепции создания АС;
  3. сопоставительный анализ требований пользователя к АС и вариантов концепции АС на предмет удовлетворения требованиям пользователя;
  4. обоснование выбора оптимального варианта концепции и описание предлагаемой АС;
  5. ожидаемые результаты и эффективность реализации выбранного варианта концепции АС;
  6. ориентировочный план реализации выбранного варианта концепции АС;
  7. необходимые затраты ресурсов на разработку, ввод в действие и обеспечение функционирования;
  8. требования, гарантирующие качество АС;
  9. условия приемки системы.

[из 2.2 прил. 1 РД 50-34.698-90]

Собственно, все... ГОСТ 34.601-90 и РД 50-34.698-90 полностью раскрывают тему проведения предпроектного обследования.

Уточнение объекта (предмета) документирования

Определиться с тем, что же следует документировать, важнее, пожалуй, даже самого проведения предпроектного обследования.

- Как писать техническую документацию?

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

Имеется одна наиболее распространенная терминологическая ошибка разработчиков - отождествление понятий «комплекс (программ)», «система обработки информации» и «автоматизированная система». Последствия ее таковы, что для разработки и документирования выбирается совершенно неподходящий комплекс или система стандартов вместо того, что реально необходим.

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

Подобный подход тяжеловат для понимания. Или, быть может, это идеология ведения бизнеса по-русски, заимствованная у китайских комсомольцев, которые сами создавали себе трудности, а затем сами же геройски их преодолевали?

Copyright © «Техническая документация» 2008-2021. Заимствуйте наши материалы с блеском! При воспроизведении материалов портала обязательна установка активной гиперссылки на источник — страницу с этой публикацией на tdocs.su.

Яндекс.Метрика