Культура проектирования_текстовые документы

1.

Культура разработки
проектной документации

2.

Документы – это важно!
Качественная документация:
Помогает при внедрении
Помогает провести испытания
Помогает закрыть проект
Помогает эксплуатировать систему

3.

Стадии проекта
Стадии
Этапы работ
1. Формирование требований к АС
1.1. Обследование объекта и обоснование необходимости создания АС.
1.2. Формирование требований пользователя к АС.
1.3. Оформление отчёта о выполненной работе и заявки на разработку АС (тактикотехнического задания)
2. Разработка концепции АС
2.1. Изучение объекта.
2.2. Проведение необходимых научно-исследовательских работ.
2.3. Разработка вариантов концепции АС, удовлетворяющего требованиям пользователя.
2.4. Оформление отчёта о выполненной работе.
3. Техническое задание
Разработка и утверждение технического задания на создание АС.
4. Эскизный проект
4.1. Разработка предварительных проектных решений по системе и её частям.
4.2. Разработка документации на АС и её части.
5. Технический проект
5.1. Разработка проектных решений по системе и её частям.
5.2. Разработка документации на АС и её части.
5.3. Разработка и оформление документации на поставку изделий для комплектования
АС и (или) технических требований (технических заданий) на их разработку.
5.4. Разработка заданий на проектирование в смежных частях проекта объекта
автоматизации.

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. Послегарантийное обслуживание.

5.

Виды документов
Стадии
Документы
3. Техническое задание
ТЗ
4. Эскизный проект
Пояснительная записка (далее – ПЗ)
5. Технический проект
Пояснительная записка (далее – ПЗ)
Схема структурная комплекса технических средств
Схема функциональная комплекса технических средств
…
6. Рабочая документация
Спецификация
План расположения оборудования и проводок
Схема подключения внешних проводок
Таблица соединений и подключений
Чертеж установки технических средств
Описание настроек
…
7. Ввод в действие
Программа и методика предварительных/приемочных испытаний
Программа опытной эксплуатации
Рабочий журнал опытной эксплуатации
Протокол предварительных/приемочных испытаний
Акт о приемке в опытную/промышленную эксплуатацию
Акт завершения опытной эксплуатации
…

6.

Взаимодействие команды
РП
Задача
Запрос
исполнителя
Руководитель отдела
Руководитель
отдела
Задача
Назначение
исполнителя
РП, ГИП
Постановка
задачи
Исполнитель
ГИП
Задача +
Исходные данные:
Состав решения
Обследование
Шаблоны документов
Исполнитель
Задача
Консультация
Выполнение
Коллеги-эксперты
ГИП
Исполнитель
Результат
Предоставление
результата
ГИП
ГИП, РП
Результат
Форматироване
Проверка
Нормоконтроль

7.

Разработка документов. ТЗ, Спецификация
Исходные данные
(предоставляет ГИП)
Обязательные:
Состав решения
Дополнительные:
Конкурсное ТЗ
Предварительная
спецификация
Хотелки
Заказчика
Процесс
Вендор решения
Компоненты решения
Предварительные требования к функциям
системы
Важно! В процессе подготовки ТЗ нужно
удостовериться, что выбранные компоненты
решения выполняют заявленные функции.
Если заявленная функция не выполняется,
обязательно сообщить об этом ГИП. ГИП
принимает решение, как решить данную
проблему.
Результат
ТЗ
Спецификация

8.

Содержание ТЗ
Техническое задание должно включать следующие разделы
(в соответствии с ГОСТ 34.602-2020 (ранее ГОСТ 34.602-89)):
1.
2.
3.
4.
5.
6.
7.
8.
Общие сведения
Цели и назначение создания автоматизированной системы
Характеристика объектов автоматизации
Требования к автоматизированной системе
Состав и содержание работ по созданию автоматизированной системы
Порядок разработки автоматизированный системы
Порядок контроля и приемки автоматизированной системы
Требования к составу и содержанию работ по подготовке объекта
автоматизации к вводу автоматизированной системы в действие
9. Требования к документированию
10. Источники разработки

9.

Рекомендации по составлению
требований к системе в ТЗ
• Требования должны быть выполнимы (если
требования ранее не были описаны, то их нужно
проверить на стенде)
• Требования должны быть достаточными, для
проверки функционала системы
• Требования не должны быть избыточными (не
нужно добавлять функции, которые не обговорены с
ГИП/Заказчиком)

10.

Содержание Спецификации
Пример оформление
спецификации по ГОСТ 21.110-2013:

11.

Разработка документов. ПЗ, Схемы для ТП
Исходные данные
(предоставляет ГИП)
Обязательные:
ТЗ
Спецификация
Состав документов
Процесс
Требования к системе/подсистеме/комплексу
Вендор решения и/или
Компоненты решения и/или
Хотелки Заказчика…
Определяется на этапе подготовки ТЗ
Разрабатывает ГИП
Шаблоны
документов
Дополнительные:
Фигуры для схем
Результаты
обследования
Существующие схемы
Выгрузки с существующего оборудования
Результат
Пояснительная
записка к
техническому
проекту
Схема структурная
комплекса
технических
средств
Схема
функциональной
структуры

12.

Содержание ПЗ
Пояснительные записки к эскизному, техническому проектам (в соответствии с ГОСТ 59795-2021)
должны содержать разделы:
1) общие положения;
2) описание процессов деятельности объекта автоматизации;
3) основные технические решения;
4) мероприятия по подготовке объекта автоматизации к вводу АС в действие.
3. В разделе "Основные технические решения" приводят:
1) решения по структуре АС и ее подсистем, по взаимодействию подсистем, по связям между
компонентами АС;
2) решения по взаимодействию АС со смежными системами и обеспечению ее совместимости;
3) решения по режимам функционирования, диагностированию работы АС;
4) решения по численности, квалификации и функциям персонала АС, режимам его работы;
5) сведения об обеспечении заданных в ТЗ на АС потребительских характеристик системы (подсистем),
определяющих ее качество;
6) состав функций, комплексов задач (задач) реализуемых АС (подсистемой);
7) решения по комплексу технических средств, его размещению на объекте.

13.

Содержание ПЗ
Наполнение раздела «Основные технические решения»:
Раздел
Наполнение
Назначение и функции комплекса
Назначение определяется в соответствии с потребностями
инфраструктуры Заказчика
Функции из ТЗ
Состав комплекса
Из спецификации
Описание технических решений
Где устанавливается
Как именно реализуются функции
Как осуществляется управление
Каким образом резервируется
Взаимодействие со смежными
комплексами
Комплекс может взаимодействовать с:
МЭ, СРК, SIEM и др.
Модель администрирования
Роли, участвующие в администрировании
Задачи для выделенных ролей
Расчет численности персонала
Уровень квалификации
Рекомендуемые курсы

14.

Рекомендации по разработке ПЗ
• Запросить шаблон документа у ГИП
• Запросить набор фигур для отрисовки схем (если необходимо)
• Уточнить степень детализации у ГИП (ЭП, ТП, ТРП…)
• Уточнить хотелки Заказчика у ГИП
• Сохранять последовательность описания для каждого
комплекса/средства
• Наименования комплексов/средств брать строго из ТЗ
• Описание должно быть применимо к инфраструктуре
Заказчика (не копи-паст из похожего проекта)

15.

Разработка документов. ВОР
Исходные данные
(предоставляет ГИП)
Обязательные:
ПЗ
Спецификация
Схемы
Шаблон ВОР
Процесс
Результат
Описание решения
Компоненты решения
Расположение и взаимодействие компонентов
ГИП предоставляет шаблон ВОР, а так же степень
детализации
ВОР

16.

Содержание ВОР
В настоящее время форма ведомости объемов
работ не установлена в действующих стандартах. В
качестве образца возможно использование
формы ведомости из отмененного ГОСТ 21.111-84
Рекомендации по разработке ВОР:
• Запросить шаблон у ГИП
• Уточнить детализацию у ГИП
• Описывать каждую функцию
(установленная/проверенная галка,
введенные/проверенные значения полей и т.п.)

17.

Разработка документов. РД
Исходные данные
(предоставляет ГИП)
Обязательные:
Готовый ТП
Результаты
обследования
Состав
документов
Фигуры для схем
Процесс
Архитектура решения
Спецификация оборудования
Фото шкафов и мест размещения
Информация об электропитании
Таблицы подключения оборудования
и т.д.
На основе исходных данных
исполнитель подготавливает:
Запрос технических условий на
размещение и подключение
оборудования
Результат
РД:
• План расположения
оборудования и
проводок
• Схема подключения
внешних проводок
• Таблица соединений
и подключений
• Чертеж установки
технических средств
• И т.д.

18.

Разработка документов. ИД
Исходные данные
(предоставляет ГИП)
Процесс
Было РД:
РД
Результаты
монтажа
Не было РД:
Готовый ТП
Результаты
обследования
Состав
документов
Фигуры для схем
По результатам монтажа
корректируется РД
Состав ИД соответствует составу РД
Фото шкафов и мест размещения
Информация об электропитании
Таблицы подключения оборудования
и т.д.
Процесс
Аналогично РД
+
Запросить у ГИП итоги СРМ
Результат
ИД:
• План расположения
оборудования и
проводок
• Схема подключения
внешних проводок
• Таблица соединений
и подключений
• Чертеж установки
технических средств
• И т.д.

19.

Разработка документов. ПМИ
Исходные данные
(предоставляет ГИП)
Обязательные:
ТЗ
Описание
решения
(ТП и/или схемы)
Процесс
Результат
Требования к системе/подсистеме/комплексу
Важно! В ПМИ должны быть описаны методики
проверки всех функций, заявленных в ТЗ.
Проверки должны быть проверены на стенде!!!
Программа и методика
предварительных
испытаний
Техническое решение
Шаблоны
документов
ГИП разрабатывает следующие документы:
• «Протокол предварительных испытаний»;
• «Акт о приемке в опытную эксплуатацию»;
• «Акт завершения опытной эксплуатации»;
• «Протокол приемочных испытаний»;
• «Акт о приемке в промышленную эксплуатацию».
Программа опытной
эксплуатации
Рабочий журнал
опытной эксплуатации
Программа и методика
приемочных испытаний

20.

Содержание ПМИ
Программы испытаний должны содержать перечни конкретных проверок (решаемых задач), которые следует осуществлять при
испытаниях для подтверждения выполнения требований ТЗ на АС, со ссылками на соответствующие методики (разделы методик)
испытаний.
Перечень проверок, подлежащих включению в программу испытаний, включает проверки
(в соответствии с ГОСТ 59795-2021):
1) соответствие АС требованиям ТЗ на АС;
2) комплектность АС;
3) качество документации;
4) Выполнение функций АС или частей АС во всех режимах функционирования, установленных в ТЗ на АС;
5) количество и квалификация обслуживающего персонала;
6) выполнение требований техники безопасности, противопожарной безопасности, экологичности, эргономики.
Программа испытаний содержит разделы:
1) объект испытаний;
2) цель испытаний;
3) общие положения;
4) объем испытаний;
5) условия и порядок проведения испытаний;
6) материально-техническое обеспечение испытаний;
7) метрологическое обеспечение испытаний;
8) отчетность.
В документ включают приложения. В зависимости от особенностей систем допускается объединять или исключать отдельные
разделы при условии изложения их содержания в других разделах программы испытаний, а также включать в нее
дополнительные разделы (при необходимости).

21.

Рекомендации по описанию
проверок ПМИ
• Должны быть описаны методики проверки для всех функций
системы, заявленные в ТЗ
• Методики проверки должны быть описаны для той версии ПО,
которая используется в данном Проекте
• Методики проверки должны быть оптимальными в части
проверки функционала и в части использования
дополнительных технических средств
• Все методики должны быть отработаны на стенде

22.

Содержание
Программы опытной эксплуатации
Программа опытной эксплуатации содержит разделы
(в соответствии с ГОСТ Р 59792-2021 (ранее ГОСТ 34.603-92)):
1)Условия и порядок функционирования АС и ее частей;
2) Продолжительность опытной эксплуатации, достаточную для проверки
правильности функционирования АС при выполнении системой всех
функций, перечисленных в ТЗ на АС, и подготовленности персонала к
работе со средствами АС в условиях ее опытной эксплуатации;
3) Порядок устранения недостатков, выявленных в процессе опытной
эксплуатации.

23.

Содержание
Журнал опытной эксплуатации
Во время опытной эксплуатации АС ведут журнал, в который (в соответствии с ГОСТ Р 597922021 (ранее ГОСТ 34.603-92)) заносят сведения о продолжительности функционирования АС,
отказах, сбоях, аварийных ситуациях, изменениях параметров объекта автоматизации,
проводимых корректировках документации и программных средств, наладке технических
средств. Сведения фиксируют в журнале с указанием даты и ответственного лица. В журнал
могут быть занесены замечания персонала по удобству эксплуатации АС.
По результатам опытной эксплуатации принимают решение о возможности (или
невозможности) предъявления частей АС и системы в целом на приемочные испытания.
Журнал опытной эксплуатации может содержать следующие разделы:
1) Общие указания
2) Объект испытаний
3 Продолжительность функционирования АС
4 Сведения об отказах и сбоях
5 Сведения о наладке технических средств
6 Сведения о корректировке документации
7 Дополнительные замечания и предложения

24.

Разработка документов. Руководства
Исходные данные
(предоставляет ГИП)
Процесс
Компоненты решения и версии ПО
Обязательные:
Спецификация
и/или
состав решения
Архитектура решения
Эксплуатационная
документация:
Руководство
администратора
Руководство
пользователя
Описание решения
(ПЗ, схемы)
Модель
администрирования
(ПЗ)
Результат
Роли, выполняющие функции администрирования
Выполняемые функции
Инструкция по
эксплуатации

25.

Содержание
Руководство СА, АБИ и т.п.
Не имеет собственного стандарта оформления.
Придерживаемся следующих правил:
Руководство описывает модель администрирования в соответствии с
проектной документацией;
Руководство содержит в себе описание всех функций, определенных в модели
администрирования;
Функции описываются применительно к внедряемой системе (не копи-паст из
руководства от производителя).
Обязательно описать процедуру резервирования и восстановления

26.

Содержание
Руководство пользователя
Руководство пользователя содержит разделы
(в соответствии с ГОСТ 59795-2021):
1) введение;
2) назначение и условия применения;
3) подготовка к работе;
4) описание операций;
5) аварийные ситуации;
6) рекомендации по освоению.

27.

Содержание
Инструкция по эксплуатации
Инструкция по эксплуатации содержит разделы
(в соответствии с ГОСТ 59795-2021):
1) общие указания;
2) меры безопасности;
3) порядок работы;
4) проверка правильности функционирования;
5) указания о действиях в разных режимах.

28.

Стиль речи в технических документах
Стиль речи
Деловой
Тон речи
нейтральный, констатирующий
Типичный вид речи
монолог
Преобладающий способ общения
массовый неконтактный
Основная форма речи
письменная
Доминирующая языковая функция
информативная

29.

Формы глаголов в документах
Система/комплекс
Средство
ТЗ
Должна выполнять/
реализовывать
Должно быть настроено/
Должно быть установлено
ТП
Выполняет/
Реализует
Настраивается/
устанавливается
ИД
Выполняет/
Реализует
Настроено/
установлено
ПМИ, ЖОЭ
Выполняет/
Реализует
Настроено/
установлено
ЭД
Выполняет/
Реализует
Настроено/
установлено
Администратор/
Пользователь
Выполняет/настраивает
Должен обладать навыками
РД
Выполнить/
настроить

30.

Единообразие терминов в рамках
одного проекта
• Наименования системы/комплекса/средства должны
браться из ТЗ
• Данные наименования должны использоваться в
документах на всех стадиях проекта
• Термины и сокращения должны быть единообразны в
рамках одного проекта
…

31.

Немного об оформлении
Стили
Для заголовков разделов, абзацев, списков
необходимо использовать «СТИЛИ».
Это поможет:
• Ускорить процесс форматирования документа
• Упростить навигацию по документу
• Автоматически собрать оглавление

32.

Немного об оформлении
Рисунки и таблицы
• Присваивать названия всем рисункам и таблицам
• Использовать данные названия по тексту с помощью
перекрестных ссылок
• Оформлять таблицы в соответствии с ГОСТом, если нет
других требований от Заказчика

33.

Немного об оформлении
Приложения
При работе с Приложениями пользоваться
правилами:
• номера Приложений должны соответствовать
последовательности упоминания их в тексте,
• на каждое Приложение в теле документа должна быть
перекрестная ссылка

34.

Правила хорошего тона
Сохранять последовательность описания для каждой
системы/подсистемы/комплекса/средства
Делить длинные предложения, если при этом смысловая
нагрузка не меняется
Вводить сокращения, использовать их далее по тексту
документа
*сокращения преимущественно не используются в названии
разделов
Ссылки на документы должны иметь формат:
… приведено в документе «Название системы. Название
документа. Децимальный номер».

35.

Слова-паразиты
Можно, возможно
В проектной документации описываются только те
функции комплекса/средства, которые реализуются в
рамках данного проекта. Если средство что-то может, но
данная функция не используется в проекте – мы ее не
описывает.
Про возможности средства лучше написать в
коммерческом предложении или в рекламном буклете
Рассмотрено ранее
Будет выполняться позже
Должна быть ссылка на проект/документ/пункт, в рамках
которого описано данное действие
Заменяем на :
Рассмотрено в пункте…. Проекте «наименование проекта»
Как бы
Разговорное, не использует в технической документации
…
…

36.

Благодарю за внимание!
Ваши вопросы?