тема 6 (1)

1.

Техническое документоведение
1.Виды технической и технологической документации
Назначение технической документации
Техническая документация - это документация, которая
используется при проектировании , изготовлении и эксплуатации
каких-либо
технических
объектов:
зданий,
сооружений,
промышленных
товаров,
программного
и
аппаратного
обеспечения.

2.

Техническая документация является составляющей проекта по
созданию,
внедрению,
сопровождению,
модернизации
и
ликвидации информационной системы на всем протяжении
жизненного цикла.
Комплекс технических документов, который регламентирует
деятельность
разработчиков,
называется
нормативнометодическим обеспечением (НМО). В данный комплекс входят:
• стандарты;
• руководящие документы;
• методики и положения;
• инструкции и т. д.

3.

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

4.

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

5.

Функции технической документации ИС:
• дает описание возможностей системы;
• обеспечивает фиксацию принятых и реализованных проектных
решений;
• определяет условия функционирования ИС;
• предоставляет информацию об эксплуатации и обслуживании
ИС;
• регламентирует процедуру защиты информации, регулирует
права различных групп пользователей;
• определяет возможности модернизации системы.

6.

Требования к технической документации:
• документы должны быть точными, полными и, по возможности,
краткими, иметь четкое и однозначное толкование;
• документация должна создаваться параллельно с разработкой
самой информационной системы;
• обязанности по документированию системы лежат на ее
разработчике;
• для повышения эффективности работы с документами должны
использоваться стандарты, регламентирующие форму и
содержание документов.

7.

2. Стандарты оформления документов, регламентов,
протоколов по информационным системам
Стандарты, имеющие отношение к разработке, внедрению и
сопровождению информационных систем можно разделить на
четыре группы:
1. Стандарты по документации на ИС;
2. Стандарты по процессам документирования ИС;
3. Стандарты по оценке качества документации на ИС;
4. Стандарты
по
информационной
безопасности
(кибербезопасности),
относящиеся
к
процессам
документирования ИС.

8.

1. Стандарты по документации на ИС
Перечень программной документации на ИС зависит от вида и
назначения конкретной системы и определяется техническим
заданием на разработку, согласованным между Поставщиком и
Заказчиком в рамках Договора на оказание услуг. Разработка
программной документации регулируется сводом стандартов,
объединенных в комплекс с индексом «19» под общим названием
ЕСПД.
Часть программной документации создается для сложных
автоматизированных систем (АСУ и АСУ ТП, включающих как
программные, так и технические компоненты) и регулируется
комплексом стандартов с индексом «34» — Информационная
технология. Комплекс стандартов на автоматизированные
системы (КСАС). При этом необходимо учитывать, что для
документации на программные компоненты систем разработчикам
необходимо соблюдать требования ЕСПД, а в отношении
документации на технические компоненты — требования ЕСКД.

9.

2. Стандарты по процессам документирования
Перечень стандартов, которые нужно использовать при
разработке документации на ИС:
• ГОСТ 2.105-95 «Общие требования к текстовым документам»;
• ГОСТ
2.610-2019
«Единая
система
конструкторской
документации.
Правила
выполнения
эксплуатационных
документов»;
• ГОСТ
2.601-2019
«Единая
система
конструкторской
документации. Эксплуатационные документы»;
• РД 50-34.698-90 «Методические указания. Информационная
технология. Комплекс стандартов и руководящих документов на
автоматизированные системы. Автоматизированные системы,
требования к содержанию документов»; (в настоящее время не
действует, взамен введен ГОСТ Р 59795-2021 "Требования к
содержанию документов")

10.

• ГОСТ 19.101-77 «ЕСПД. Виды программ и программных
документов»;
• ГОСТ 19.105-78 «ЕСПД. Общие требования к программным
документам»;
• ГОСТ 19.106-78 «ЕСПД. Требования к программным документам,
выполненным печатным способом»;
• ГОСТ 19.604-78 «ЕСПД. Правила внесения изменений в
программные документы, выполненные печатным способом»;
• ГОСТ 34.201-2020 «Информационные технологии. Комплекс
стандартов
на
автоматизированные
системы.
Виды,
комплектность и обозначение документов при создании
автоматизированных систем»;
• ГОСТ Р ИСО/МЭК 15910-2006 «Процесс создания документации
пользователя программного средства»;
• Р 50-34.126-92 «Рекомендация. Информационная технология.
Правила проведения работ при создании автоматизированных
систем».

11.

3. Стандарты по оценке качества документации
Перечень стандартов, которые следует учитывать при
разработке документации и по которым проводится сертификация
или аттестация ИС:
• ГОСТ 28195-89 «Оценка качества программных средств. Общие
положения» — по части оценки программной документации;
• ГОСТ Р ИСО/МЭК 25041-2014 «Информационные технологии
(ИТ). Системная и программная инженерия. Требования и оценка
качества систем и программного обеспечения (SQuaRE).
Руководство по оценке для разработчиков, приобретателей и
независимых
оценщиков»
—
по
части
оценки
эксплуатационной документации;
• ГОСТ Р ИСО/МЭК ТО 9294-93 «Информационная технология.
Руководство по управлению документированием программного
обеспечения» — по части определений, терминологии и
типологии документации;

12.

4. Стандарты по информационной безопасности, относящиеся к
процессам документирования.
Перечень стандартов по ИБ, которые следует учитывать при
составлении документации на ИС:
• ГОСТ Р 53114-2008 «Защита информации. Обеспечение
информационной безопасности в организации. Основные
термины и определения»;
• ГОСТ Р 50922-2006 «Защита информации. Основные термины и
определения»
• Р 50.1.053-2005 «Информационные технологии. Основные
термины и определения в области технической защиты
информации»;
• ГОСТ
Р
51275-2006
«Защита
информации.
Объект
информатизации. Факторы, воздействующие на информацию.
Общие положения»;

13.

• ГОСТ Р ИСО/МЭК 15408-1-2012 «Информационная технология.
Методы и средства обеспечения безопасности. Критерии оценки
безопасности информационных технологий. Часть 1. Введение и
общая модель»;
• ГОСТ Р ИСО/МЭК 27001-2021 «Информационная технология.
Методы и средства обеспечения безопасности. Системы
менеджмента информационной безопасности. Требования».
Прямое применение международного стандарта — ISO/IEC
27001:2005;
• ГОСТ Р ИСО/МЭК 27000-2021 «Информационная технология.
Методы и средства обеспечения безопасности. Системы
менеджмента информационной безопасности. Общий обзор и
терминология»;
• ГОСТ Р ИСО/МЭК 27034-1-2014 «Информационная технология
(ИТ).
Методы
и
средства
обеспечения
безопасности.
Безопасность приложений. Часть 1. Обзор и общие понятия».

14.

Ключевые моменты оформления программной документации.
Документы, которые позволяют пользователям выполнять
конкретные действия для четко определенных результатов,
считаются ориентированными на задачи (task-oriented).
Atask-oriented документ пытается описать производительность
в достаточном количестве, чтобы позволить читателю выполнить
задачу. К task-oriented документам, относятся спецификации,
документация и инструкции, которые позволяют своим
пользователям выполнять конкретные задачи.
Программная документация является неотъемлемым компонентом
программного продукта и должна оформляться в соответствии с
Единой системой программной документации (ЕСПД - ГОСТ серии 19).

15.

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

16.

К эксплуатационным документам относят:
• описание применения (сведения о назначении программы,
области применения, применяемых методах, классе решаемых
задач,
ограничениях
для
применения,
минимальной
конфигурации технических средств);
• руководство системного программиста (сведения для
проверки,
обеспечения
функционирования
и
настройки
программы на условия конкретного применения);
• руководство программиста (сведения для эксплуатации
программы);
• руководство оператора (сведения для обеспечения общения
оператора с ВС в процессе выполнения программы);
• описание языка (описание синтаксиса и семантики языка);
• руководство по техническому обслуживанию (сведения для
применения тестовых и диагностических программ при
обслуживании ТС)

17.

Техническое задание. В техническое задание включают:
• введение (наименование, краткая характеристика области
применения программы);
• основания для разработки (документы, на основании которых
ведётся разработка, организация, утвердившая документы, дата
утверждения, наименование и обозначение темы разработки);
• назначение разработки (функциональное и эксплуатационное
назначение программы);
• требования к программе и программной документации;
• технико-экономические показатели;
• стадии и этапы разработки;
• порядок контроля и приёмки.

18.

Наиболее существенной частью технического задания
является раздел "требования..." В этом разделе приводятся:
• требования к функциональным характеристикам (состав
выполняемых функций, организация входных и выходных данных,
временные характеристики);
• требования
к
надёжности
(обеспечение
устойчивого
функционирования, контроль входной и выходной информации,
время восстановления после отказа);
• требования
к
информационной
и
программной
совместимости (требования к информационным структурам на
входе и выходе, методам решения, исходным кодам, языкам
программирования и программным средствам; требования к ЗИ);
• требования к составу и параметрам технических средств;
• требования к программной документации.
Данный раздел может содержать требования к маркировке,
упаковке, транспортировке и хранению, а также условия эксплуатации.

19.

Описание
содержит:
программы.
Документ
"Описание
программы"
• общие сведения (обозначение наименование программы,
программное обеспечение, необходимое для функционирования
программы, языки программирования, на которых написана
программа);
• функциональное назначение (классы решаемых задач,
сведения о функциональных ограничениях на применение);
• описание логической структуры (алгоритм программы,
используемые методы, структура программы с описанием
составных частей и связи между ними);
• используемые технические средства (типы ЭВМ и устройств,
которые используются при работе программы);

20.

• вызов
и
загрузка
(способ
вызова
соответствующего носителя данных);
программы
с
• входные данные (характер, организация и предварительная
подготовка входных данных, а также их формат, описание и
способ кодирования);
• выходные данные (характер и организация выходных данных, а
также их формат, описание и способ кодирования).
Описание логической структуры программы следует сопровождать
блок-схемой программы.
Документ "Описание программы" может содержать также схемы
данных, схемы взаимодействия программ, схемы ресурсов системы и
проч., оформленные в соответствии с ГОСТ 19.701-90.

21.

Описание применения. Документ "Описание применения"
относится к эксплуатационным документам и состоит из
следующих разделов:
• назначение
программы
(возможности,
характеристики, ограничения области применения);
основные
• условия применения (требования к техническим и программным
средствам, общие характеристики входной и выходной
информации, а также требования и условия организационного,
технического и технологического характера);
• описание задачи (указываются определения задачи и методы её
решения);
• входные и выходные данные.

22.

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

23.

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

24.

Руководство оператора. Документ "Руководство оператора"
относится к эксплуатационным документам и состоит из
следующих разделов:
• назначение программы (информация, достаточная для
понимания функций программы и её эксплуатации);
• условия выполнения программы (минимальный и/или
максимальный набор технических и программных средств и т. п.);
• выполнение
программы
(последовательность
действий
оператора, обеспечивающих загрузку, запуск, выполнение и
завершение программы; описываются функции, форматы и
возможные варианты команд, с помощью которых оператор
осуществляет загрузку и управляет выполнением программы, а
также ответы программы на эти команды);
• сообщения оператору (тексты сообщений, выдаваемых
оператору в ходе выполнения программы и описание
необходимых действий).