Структура системы документирования продукта - История изменений

OpenCodeBot: Оптимизация: добавлено meta description ({{#description2}})

2026-08-31T21:00:41Z

Оптимизация: добавлено meta description ({{#description2}})

← Предыдущая версия		Версия от 00:00, 1 сентября 2026
Строка 1:		Строка 1:
			{{#description2:Структура системы документирования продукта: содержание документов, ответственные за разработку и получатели.}}
	{{TBD}}		{{TBD}}

KlimoveaBot: Техническая правка: удалён , добавлен {{Backlinks}} (KlimoveaBot)

2026-08-16T19:44:46Z

Техническая правка: удалён <comments/>, добавлен {{Backlinks}} (KlimoveaBot)

← Предыдущая версия		Версия от 22:44, 16 августа 2026
Строка 68:		Строка 68:
	\|Разработчик		\|Разработчик
	\|}		\|}


	'''Для каждого сервиса в отдельности'''		'''Для каждого сервиса в отдельности'''
Строка 317:		Строка 316:
	##взаимодействие с поставщиком (техническая поддержка).		##взаимодействие с поставщиком (техническая поддержка).
	#Порядок изменения паспорта информационной системы и контроль его актуальности.		#Порядок изменения паспорта информационной системы и контроль его актуальности.
			{{Backlinks}}
	[[Категория:Цифровизация]]		[[Категория:Цифровизация]]

Евгений Климов: /* Применяемые документы */

2025-12-06T18:54:55Z

Применяемые документы

← Предыдущая версия		Версия от 21:54, 6 декабря 2025
Строка 46:		Строка 46:
	\|Определение целей и задач продукта.		\|Определение целей и задач продукта.
	\|Владелец продукта		\|Владелец продукта
	\|Все сотрудники ~~ЦТП~~		\|Все сотрудники
	\|-		\|-
	\|Функциональная структура (ФС)		\|Функциональная структура (ФС)
	\|PRD, PSD		\|PRD, PSD
	\|Определение реестра сервисов, функциональной архитектуры, потоков данных между сервисами и с другими системами, базовой ролевой и функционально-ролевой моделью в терминах прикладной области без учета технического контекста		\|Определение реестра сервисов, функциональной архитектуры, потоков данных между сервисами и с другими системами, базовой ролевой и функционально-ролевой моделью в терминах прикладной области без учета технического контекста
	\|Функциональный архитектор ~~ЦТП~~		\|Функциональный архитектор
	\|Владелец сервиса ~~ЦТП~~,		\|Владелец сервиса,

	Функциональный архитектор ~~ЦТП~~		Функциональный архитектор
	\|-		\|-
	\|Требования к интерфейсу		\|Требования к интерфейсу
Строка 62:		Строка 62:
	\|Разработчик		\|Разработчик
	\|-		\|-
	\|Технические требования к ~~сервису~~		\|Технические требования к продукту
	\|SRD		\|SRD
	\|Определение единых технических требований к разрабатываемому ~~сервису~~ в целях подключения в единую платформу и обеспечения совместимости.		\|Определение единых технических требований к разрабатываемому продукту в целях подключения в единую платформу и обеспечения совместимости.
	\|Системный архитектор		\|Системный архитектор
	\|Разработчик		\|Разработчик
Строка 81:		Строка 81:
	\|PV, BRD		\|PV, BRD
	\|Определение целей и задач сервиса, основных пользователей, места в экосистеме.		\|Определение целей и задач сервиса, основных пользователей, места в экосистеме.
	\|Владелец продукта (сервиса) ~~ЦТП~~		\|Владелец продукта (сервиса)
	\|Бизнес-аналитик ~~ЦТП~~		\|Бизнес-аналитик
	\|-		\|-
	\|Функциональные требования (ФТ)		\|Функциональные требования (ФТ)
	\|PRD, PSD		\|PRD, PSD
	\|Определение реестра функций, требований к ним, ролевой и функционально-ролевой модели в терминах прикладной области без учета технического контекста		\|Определение реестра функций, требований к ним, ролевой и функционально-ролевой модели в терминах прикладной области без учета технического контекста
	\|Бизнес-аналитик ~~ЦТП~~		\|Бизнес-аналитик
	\|Системный аналитик ~~ЦТП~~		\|Системный аналитик
	\|-		\|-
	\|Техническое задание (ТЗ)		\|Техническое задание (ТЗ)
	\|SRD, SRS		\|SRD, SRS
	\|Определение требований к информационной системе исходя из функциональных требований, с учетом технических аспектов и с учетом технического контекста		\|Определение требований к информационной системе исходя из функциональных требований, с учетом технических аспектов и с учетом технического контекста
	\|Системный аналитик ~~ЦТП~~		\|Системный аналитик
	\|Разработчик		\|Разработчик
	\|-		\|-
Строка 114:		Строка 114:

	(функциональный архитектор)		(функциональный архитектор)
	\|Архитектор ~~ЦТП~~		\|Архитектор
	\|-		\|-
	\|Техническая спецификация		\|Техническая спецификация
Строка 120:		Строка 120:
	\|Описание структуры базы данных, спецификация на API		\|Описание структуры базы данных, спецификация на API
	\|Разработчик (системный архитектор)		\|Разработчик (системный архитектор)
	\|Архитектор ~~ЦТП~~		\|Архитектор
	\|-		\|-
	\|Программа и методика испытаний (ПМИ)		\|Программа и методика испытаний (ПМИ)
Строка 132:		Строка 132:
	\|Описание процедур установки и обеспечения эксплуатации программного обеспечения		\|Описание процедур установки и обеспечения эксплуатации программного обеспечения
	\|Разработчик		\|Разработчик
	\|DevOps ~~ЦТП~~		\|DevOps
	\|-		\|-
	\|Руководство функционального администратора		\|Руководство функционального администратора
Строка 140:		Строка 140:

	(функциональный архитектор)		(функциональный архитектор)
	\|Функциональный администратор ~~ЦТП~~		\|Функциональный администратор
	\|-		\|-
	\|Руководство пользователя		\|Руководство пользователя
Строка 154:		Строка 154:
	\|Информация о системе, необходимая для обеспечения её эксплуатации.		\|Информация о системе, необходимая для обеспечения её эксплуатации.
	\|Разработчик (DevOps)		\|Разработчик (DevOps)
	\|DеvOps ~~ЦТП~~		\|DеvOps
	\|}		\|}

Строка 241:		Строка 241:

	Состав определяется разработчиком.		Состав определяется разработчиком.

	~~Является внутренним документом разработчика и может не предоставляться ЦТП.~~

	== Функциональная спецификация ==		== Функциональная спецификация ==
Строка 262:		Строка 260:
	Документ описывает техническую архитектуру программного обеспечения сервиса.		Документ описывает техническую архитектуру программного обеспечения сервиса.

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

	В документе указываются:		В документе указываются:

Евгений Климов: /* Концепция платформы */

2025-12-06T18:49:51Z

Концепция платформы

← Предыдущая версия		Версия от 21:49, 6 декабря 2025
Строка 4:		Строка 4:

	== Введение ==		== Введение ==
	Настоящий документ определяет структуру, общую информацию о содержании документов, ответственных за разработку и получателей (пользователей) документов, разрабатываемых в процессе реализации ~~платформы~~ и её сервисов.		Настоящий документ определяет структуру, общую информацию о содержании документов, ответственных за разработку и получателей (пользователей) документов, разрабатываемых в процессе реализации продукта и её сервисов.

	Состав и структура представленной в документе документации разработаны в целях обеспечения полноты и непрерывности формирования и передачи информации от этапа формирования идеи продукта до ввода в эксплуатацию между всеми участниками процесса.		Состав и структура представленной в документе документации разработаны в целях обеспечения полноты и непрерывности формирования и передачи информации от этапа формирования идеи продукта до ввода в эксплуатацию между всеми участниками процесса.
Строка 34:		Строка 34:

	== Применяемые документы ==		== Применяемые документы ==
	'''Для ~~платформы~~ в целом'''		'''Для продукта в целом'''
	{\| class="wikitable"		{\| class="wikitable"
	\|'''Наименование'''		\|'''Наименование'''
Строка 42:		Строка 42:
	\|'''Получатель (пользователь)'''		\|'''Получатель (пользователь)'''
	\|-		\|-
	\|Концепция ~~платформы~~		\|Концепция продукта
	\|PV		\|PV
	\|Определение целей и задач продукта.		\|Определение целей и задач продукта.
	\|Владелец ~~платформы~~		\|Владелец продукта
	\|Все сотрудники ЦТП		\|Все сотрудники ЦТП
	\|-		\|-
Строка 59:		Строка 59:
	\|UI/UX Guide		\|UI/UX Guide
	\|Определение единых требований к интерфейсу, визуальным элементам		\|Определение единых требований к интерфейсу, визуальным элементам
	\|Дизайнер ~~платформы~~		\|Дизайнер продукта
	\|Разработчик		\|Разработчик
	\|-		\|-
Строка 160:		Строка 160:
	Ниже даны краткие описания документов. Детальные требования к документам и методики их разработки фиксируются отдельными документами.		Ниже даны краткие описания документов. Детальные требования к документам и методики их разработки фиксируются отдельными документами.

	== Концепция ~~платформы~~ ==		== Концепция продукта ==
	Документ создается для формирования единой системы ценностей и целеполагания при формировании ~~сервисов платформы~~ и её развития в целом.		Документ создается для формирования единой системы ценностей и целеполагания при формировании продукта и его развития в целом.

	Концепция определяет:		Концепция определяет:

	* Цели создания и существования ~~платформы~~.		* Цели создания и существования продукта.
	* Задачи, выполняемые ~~платформой~~ для реализации целей.		* Задачи, выполняемые продуктом для реализации целей.
	* Стороны, вовлеченные в использование ~~платформы~~.		* Стороны, вовлеченные в использование продукта.

	== Функциональная структура ==		== Функциональная структура ==
	Документ создается для понимания сущности ~~платформы~~ в целом, как множества совместно действующих элементов.		Документ создается для понимания сущности продукта в целом, как множества совместно действующих элементов.

	В документе фиксируется текущая информация о:		В документе фиксируется текущая информация о:

	* Реестре сервисов.		* Реестре сервисов.
	* Функциональной архитектуре ~~платформы~~, как совокупности сервисов, объединенной потоками данных.		* Функциональной архитектуре продукта, как совокупности сервисов, объединенной потоками данных.
	* Потоках данных с внешними по отношению к платформе системами.		* Потоках данных с внешними по отношению к платформе системами.
	* Базовой функциональности, относящейся ко всей платформе.		* Базовой функциональности, относящейся ко всей платформе.
Строка 181:		Строка 181:

	== Требования к интерфейсу ==		== Требования к интерфейсу ==
	Документ создается для обеспечения единого подхода к формированию пользовательского интерфейса в сервисах ~~платформы~~.		Документ создается для обеспечения единого подхода к формированию пользовательского интерфейса в сервисах продукта.

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

	* Цели создания сервиса с указанием их влияния на основную цель ~~платформы~~.		* Цели создания сервиса с указанием их влияния на основную цель продукта.
	* Задачи, выполняемые сервисом.		* Задачи, выполняемые сервисом.
	* Проблемы, решаемые сервисом (при наличии).		* Проблемы, решаемые сервисом (при наличии).
	* Аудитория сервиса.		* Аудитория сервиса.
	* Место в экосистеме сервиса, влияние и взаимодействие с другими сервисами ~~платформы~~ или иными внешними системами.		* Место в экосистеме сервиса, влияние и взаимодействие с другими сервисами продукта или иными внешними системами.
	* Качественные и количественные показатели сервиса (плановое количество компаний, воспользовавшихся сервисом, ожидаемый эффект от реализации для отдельной компании, для всех компаний, воспользовавшихся сервисом и т.п.).		* Качественные и количественные показатели сервиса (плановое количество компаний, воспользовавшихся сервисом, ожидаемый эффект от реализации для отдельной компании, для всех компаний, воспользовавшихся сервисом и т.п.).
	* Описание сервиса в бизнес-терминах, логика, безотносительно к применению программного продукта и информационных технологий вообще.		* Описание сервиса в бизнес-терминах, логика, безотносительно к применению программного продукта и информационных технологий вообще.
Строка 245:		Строка 245:

	== Функциональная спецификация ==		== Функциональная спецификация ==
	Функциональная спецификация описывает функциональную структуру и потоки данных сервиса в окончательном состоянии после завершения разработки в бизнес-терминах безотносительно примененной ~~платформы~~.		Функциональная спецификация описывает функциональную структуру и потоки данных сервиса в окончательном состоянии после завершения разработки в бизнес-терминах безотносительно примененной продукта.

	Документ необходим для :		Документ необходим для :

Евгений Климов в 18:47, 6 декабря 2025

2025-12-06T18:47:01Z

← Предыдущая версия		Версия от 21:47, 6 декабря 2025
Строка 1:		Строка 1:
	TBD		{{TBD}}

	Делал для одной компании. Не универсально.		Делал для одной компании. Не универсально.

Евгений Климов в 19:44, 14 сентября 2025

2025-09-14T19:44:26Z

← Предыдущая версия		Версия от 22:44, 14 сентября 2025
Строка 1:		Строка 1:
			TBD

	Делал для одной компании. Не универсально.		Делал для одной компании. Не универсально.

Евгений Климов в 13:11, 23 ноября 2024

2024-11-23T13:11:59Z

← Предыдущая версия		Версия от 16:11, 23 ноября 2024
Строка 317:		Строка 317:
	##взаимодействие с поставщиком (техническая поддержка).		##взаимодействие с поставщиком (техническая поддержка).
	#Порядок изменения паспорта информационной системы и контроль его актуальности.		#Порядок изменения паспорта информационной системы и контроль его актуальности.
			[[Категория:Цифровизация]]

Евгений Климов: /* Паспорт сервиса */

2024-11-23T12:36:12Z

Паспорт сервиса

← Предыдущая версия		Версия от 15:36, 23 ноября 2024
Строка 295:		Строка 295:

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

	Паспорт состоит из следующих разделов:		Паспорт состоит из следующих разделов:

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

	~~3. Основные~~ эксплуатационные характеристики информационной системы:

	## контролируемые параметры;

	## документация;

	c. политика управления учетными записями пользователей;

	~~d. регламент~~ резервного копирования и восстановления;

	e. нестандартные процедуры, мониторинг и регламентные работы;

	~~f. взаимодействие~~ с поставщиком (техническая поддержка).

	~~4. Порядок~~ изменения паспорта информационной системы и контроль его актуальности.

Евгений Климов: /* Паспорт сервиса */

2024-11-23T12:24:49Z

Паспорт сервиса

← Предыдущая версия		Версия от 15:24, 23 ноября 2024
Строка 301:		Строка 301:
	# Общая информация об информационной системе:		# Общая информация об информационной системе:

	## состав подсистем и информация о них;		## состав подсистем и информация о них

	## используемые программные продукты и ПО		## используемые программные продукты и ПО

Евгений Климов в 12:04, 23 ноября 2024

2024-11-23T12:04:54Z

← Предыдущая версия		Версия от 15:04, 23 ноября 2024
Строка 301:		Строка 301:
	# Общая информация об информационной системе:		# Общая информация об информационной системе:

	# a. состав подсистем и информация о них;		## состав подсистем и информация о них;

	b. используемые программные продукты и ПО		## используемые программные продукты и ПО

	c. используемое оборудование (собственное и арендуемое);		## используемое оборудование (собственное и арендуемое);

	~~d. стоимость~~ внедрения (в том числе по подсистемам);		## стоимость внедрения (в том числе по подсистемам);

	e. стоимость сопровождения (на год).		## стоимость сопровождения (на год).

	2. Состав информационной системы:		# Состав информационной системы:

	a. основные компоненты и подсистемы;		## основные компоненты и подсистемы;

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

	3. Основные эксплуатационные характеристики информационной системы:		3. Основные эксплуатационные характеристики информационной системы:

	a. контролируемые параметры;		## контролируемые параметры;

	b. документация;		## документация;

	c. политика управления учетными записями пользователей;		c. политика управления учетными записями пользователей;