Техническая документация информационных систем

1. Техническая документация информационных систем

ХАБИБРАХМАНОВА А ЛСУ ИЛЬГАМОВНА

2. Содержание

Назначение технической документации
Виды документации для программного обеспечения
Требования к технической документации
28.02.2026

3.

4.

Документация
обеспечивает
«общее
пространство»
проекта.
Команда говорит
«на одном языке»
Только тщательно
описанные
требования могут
быть проверены на
полноту и
непротиворечивость
Документирование
позволяет четко
разграничить зоны
ответственности
между участниками
проекта.
28.02.2026

5.

«как нужно сделать?
Техническое
задание
Технический
проект
«что нужно сделать?»
28.02.2026

6.

Аналитик
Заказчик
Менеджер
проекта
Разработчики
Технические писатели
Тестировщики
КТО УЧАСТВУЕТ В РАЗРАБОТКЕ ТЕХНИЧЕСКОЙ ДОКУМЕНТАЦИИ
28.02.2026

7. Роль технического писателя

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

8. Какая техническая документация нужна разработчику

ТЗ
28.02.2026

9.

Техническое
задание
—
это
документ,
регламентирующий бизнес-цели, общее описание
системы, объем работ, границы проекта, а также
порядок разработки, оценки и приемки. Данный
документ отвечает нам на вопрос «что нужно
сделать?» и фактически является постановкой
задачи.
28.02.2026

10. Какая техническая документация нужна разработчику

Техническое
задание
Технический
проект
28.02.2026

11.

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

12. Какая техническая документация нужна разработчику

Техническое
задание
Технический
проект
Разработка
системы и ее
тестирование
28.02.2026

13. Виды документации для программного обеспечения

• Проектная – включает описание основных положений,
используемых при создании ПО и рабочей среды.
• Техническая – алгоритмы, код, интерфейсы, АРI.
• Пользовательская – руководства для пользователей
программы.
• Маркетинговая – содержащая рекламную информацию
о продукте.
28.02.2026

14. Проектная документация

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

15. Основные документы, которые входят в состав проектной документации

•техническое задание;
•пояснительная записка;
•программа и методика испытаний;
•описание программы / программного
обеспечения и др.
28.02.2026

16. Отечественные стандарты

ЕСКД, Единая система конструкторской документации (ГОСТ 2);
ЕСПД, Единая система программной документации (ГОСТ 19);
КСАС, Комплекс стандартов на автоматизированные системы
(ГОСТ 34).
28.02.2026

17. Зарубежные стандарты 

Зарубежные стандарты
Requirements, описание требований и характеристик
программного обеспечения (аналог Техническое задание);
Architecture/Design, описание архитектуры и
взаимосвязей (аналог Пояснительная записка);
Technical, описание кода, алгоритмов и
интерфейсов (аналог Описание программы).
28.02.2026

18.

Процесс разработки в западных компаниях осуществляется в
соответствии с международными стандартами, в частности
ISO/IEC/IEEE 90003:2018 структура которого выстроена в
соответствии с ISO 9001:2015. При этом компании при
разработке
руководствуются
собственной
документацией,
составленной с учетом рекомендаций и обязательных требований
стандартов. В общем случае документацию по разрабатываемому
ПО можно разделить на два типа:
1. Программная документация;
2. Пользовательская документация.
28.02.2026

19.

Программная документация
Пользовательская документация
•документы, описывающие
программу и ее
части ((документы с
техническими требованиями,
проектными решениями,
описанием архитектуры,
исходный код программы и
ответы на часто задаваемые
вопросы)).
•руководства для конечных
пользователей программы и
системных
администраторов ((руководства
пользователя, по устранению
неполадок, по установке,
справочные руководства и
обучающие материалы)).
28.02.2026

20. Программная документация

Документы с требованиями к программе;
Документы по дизайну UI / UX;
Документы по проектированию архитектуры ПО;
Документы содержащие исходный код программы;
Документация по интерфейсам прикладного программирования (API);
Документация по обеспечению качества (тестированию ПО);
Документация по техническому обслуживанию или справочное руководство.
28.02.2026

21. Документы с требованиями к программе (PRD)

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

22. Создание UI / UX

начинается со стадии разработки требований и проходит через все этапы
разработки, включая этапы тестирования и релиза.
Процесс UI / UX-дизайна включает в себя исследование, создание
прототипа, тестирование удобства использования и саму часть
проектирования, в ходе которой создается большое количество
документации.
28.02.2026

23. Документация по проектированию архитектуры ПО (техническая спецификация)

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

24. Документы, содержащие исходный код программы

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

25. Документация по интерфейсам прикладного программирования (API)

предназначена для разработчиков и содержит информацию о том, как
эффективно использовать необходимые API разработанного ПО и
подключаться к ним. Документация этого типа также должна содержать
список всех доступных API со спецификациями для каждого из них и
представлена, как правило, в виде руководств или учебных пособий.
28.02.2026

26. Документация по обеспечению качества (тестированию ПО)

предназначена для специалистов в области тестирования ПО,
инженеров по управлению качеством ПО, менеджеров проектов и
может содержать:
1. Планы управления качеством;
2. Документацию для тестирования.
28.02.2026

27.

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

28. Документация по техническому обслуживанию ПО и справочная документация

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

29. Документация для конечного пользователя

должна быть максимально простой и объяснять, как можно использовать
ПО при решении той или иной задачи. Документация данного типа может
быть предоставлена в печатном виде, офлайн на устройстве или на онлайн
ресурсах. К основным типам пользовательских документов относятся:
1. Краткое или полное руководство;
2. Руководство по устранению неполадок.
28.02.2026

30. Документация системного администратора

обычно охватывает установку и обновление ПО, которые
помогают системному администратору в обслуживании
программного продукта. Стандартными документами
системного администратора являются:
1. Функциональное описание;
2. Руководство системного администратора.
28.02.2026

31. В состав документации сопровождения управления конфигу­рацией входят:

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