Всем привет! Меня зовут Мишинёва Екатерина, я – ведущий технический писатель с опытом работы в сфере IT более 10 лет.

Что представляет собой документ "Общее описание системы"

Для начала я бы хотела дать некоторое определение документу «Общее описание системы».

Документ «Общее описание системы» для автоматизированной системы разрабатывается с целью предоставления общей информации о системе, её назначении, основных компонентах и принципах работы. Другими словами – этот документ служит неким источником базовых знаний о системе для новых сотрудников, а также может использоваться для ознакомления лиц, заинтересованных в системе, но не обладающих глубокими знаниями в данной предметной области. Кроме того, наполнение документа будет постоянно совершенствоваться по мере уточнения требований. Общее описание также может включать информацию о среде функционирования системы, требованиях к аппаратному и программному обеспечению, интерфейсах с другими системами и т.д.

На какой стадии разрабатывается

Согласно ГОСТ 34.201-2020 документ «Общее описание системы» разрабатывается на стадии создания АС «Рабочая документация».

Какие функции выполняет этот документ

Что касается функций, которые выполняет документ «Общее описание системы», для себя я выделила следующие:

1. Введение в систему – предоставляет общую информацию о системе, ее назначении и основных компонентах. Это помогает новым сотрудникам быстро ознакомиться с системой и понять ее функции и структуру.

2. Описание работы системы – описывает принципы работы системы, включая взаимодействие между ее компонентами и обработку данных. Это позволяет разработчикам понять, как система работает и какие требования к ее разработке и внедрению.

3. Описание среды функционирования – может также описывать среду, в которой функционирует система, включая требования к аппаратному обеспечению и программному обеспечению. Это помогает разработчикам определить, какие компоненты необходимы для функционирования системы и как они должны быть интегрированы.

4. Описание интерфейсов – может описывать интерфейсы между системой и другими системами или компонентами. Это помогает обеспечить совместимость и взаимодействие между различными элементами системы. Но отмечу, что не стоит в Общее описание системы не глядя включать целое Руководство пользователя, все-таки это разные документы.

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

6. Контроль качества – документ может использоваться для контроля качества разработки системы, проверяя, что все требования и спецификации были выполнены.

Отличительные особенности, чем отличается от ТЗ, ЧТЗ, РП

Сначала я подумала, какие выделить документы для сравнения с документом «Общее описание системы»?

В итоге пришла к тому, что Техническое задание/Частное техническое задание и Руководство пользователя будут самыми подходящими, чтобы еще раз выделить отличительные особенности уже в сравнении их друг с другом.

1. Техническое задание/Частное техническое задание.

Документ «Общее описание системы» является более общим и вводным по сравнению с ТЗ и ЧТЗ. Он предоставляет общую информацию о системе и ее назначении, в то время как ТЗ/ЧТЗ содержат более конкретные требования и спецификации. «Общее описание системы» может быть использовано в качестве вводного материала для новых сотрудников или для общего ознакомления с системой, в то время как ТЗ/ЧТЗ используется разработчиками для создания системы в соответствии с определенными требованиями.

2. Руководство пользователя.

Документ «Общее описание системы» предназначен для описания основных характеристик и функций системы, в то время как «Руководство пользователя» содержит более подробную информацию о том, как использовать систему, какие функции доступны и как они работают. «Общее описание системы» обычно пишется для разработчиков или технических специалистов, в то время как «Руководство пользователя» предназначено для конечных пользователей системы.

Какими ГОСТами регулируется

• ГОСТ Р 59795-2021 «Комплекс стандартов на автоматизированные системы. Автоматизированные системы. Требования к содержанию документов» – для определения содержания документа.

• ГОСТ 34.601-90 «Комплекс стандартов на автоматизированные системы. Автоматизированные системы. Стадии создания» – определяет на какой стадии создания АС какой документ должен быть разработан, а в нашем случае документ «Общее описание системы».

• ГОСТ 34.201-2020 «Комплекс стандартов на автоматизированные системы. Виды, комплектность и обозначение документов при создании автоматизированных систем».

Сбор информации для разработки для данного документа

Собрать информацию для документа «Общее описание системы», в прочем также как и для других документов, технический писатель может от системных аналитиков, руководителя проекта, иногда от разработчиков. Также очень полезно будет изучить уже существующую в компании wiki (базу знаний) и при наличии уже какого-то готового варианта АС или MVP и доступов самостоятельно изучить функциональность системы.  

Базовая структура

В соответствии с ГОСТ Р 59795-2021 «Информационные технологии. Комплекс стандартов на автоматизированные системы. Автоматизированные системы. Требования к содержанию документов» документ «Общее описание системы» должен содержать следующие разделы:

1. Назначение АС

1.1   Вид деятельности, для автоматизации которой предназначена АС

1.2   Перечень объектов автоматизации, на которых используется АС

1.3   Перечень функций, реализуемых АС

2. Описание АС

2.1   Структура АС и назначение ее частей

2.2   Сведения об АС в целом и ее частях, необходимые для обеспечения эксплуатации

2.3   Описание функционирования АС и ее частей

3. Описание взаимосвязей АС с другими АС

3.1   Перечень АС, с которыми взаимодействует данная АС

3.2   Описание связей между АС

3.3   Описание информации взаимообмена

4. Описание подсистем (при необходимости)

4.1   Структура подсистем и назначение их частей

4.2   Сведения о подсистемах и их частях, необходимые для обеспечения их функционирования

4.3   Описание функционирования подсистем и их частей

Также хочу отметить, что согласно этого же ГОСТа, содержание документа, при необходимости, может дополняться в зависимости от особенностей создаваемой АС.