Реестр функций

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

Иллюстрации в документе подготовлены с использованием демонстрационной базы с вымышленными сведениями. Совпадения с реальными данными случайны.

Предназначение инструмента

«Реестр функций» помогает сформировать и поддерживать функциональную модель системы. Подходит как для полного цикла разработки программ, так и для доработок — от небольших правок до реализации крупных подсистем. Инструмент способствует эффективному развитию и сопровождению системы.

Ключевые возможности инструмента:

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

Инструмент распространяется в виде конфигурации для платформы «1С:Предприятие 8.3» версии 8.3.27.1786 и выше. Поддерживает работу в режиме тонкого, толстого и веб-клиента.

Основные принципы работы

«Реестр функций» для построения функциональной модели системы опирается на три ключевые аналитики и связи между ними: функции, задачи и объекты конфигурации.

Функции

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

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

1 уровень. Функциональные блоки — крупные разделы системы.
2 уровень. Группы функций — логические группы внутри блоков.
3 уровень. Конкретные функции — детальные возможности системы.

В карточке функции можно добавить её развернутое описание в формате HTML. Это позволяет вставлять фрагменты текста из технического задания с сохранением исходного форматирования. На закладке «Внутреннее обсуждение» доступна возможность оставлять комментарии с указанием автора и даты.

Задачи

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

В задаче можно отметить необходимость создания или изменения инструкций и сценариев тестирования. Создание задач осуществляется как вручную, так и путём переноса из внешних систем (например, «Трекер заданий 1С», «Яндекс Трекер», «Битрикс24» и т. п.).

На закладке «Функции и объекты задачи» указывается, на какие функции системы повлияла данная задача. В поле «Действие» описывается характер внесённых изменений в конкретные объекты системы (например, создание, изменение прав доступа или удаление).

Реестр функций

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

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

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

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

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

Инструкции

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

Инструкция может быть связана с рядом функций, объектов системы и задач. Эта связь настраивается в карточке инструкции на закладке «Задачи и функции».

Анализ наличия и обновления инструкций

Система предоставляет анализ инструкций по задачам и функциям проекта.

В отчёте «Анализ наличия инструкций» представлен реестр имеющихся инструкций с ключевой информацией: статус, дата проверки, исполнители, описание, а также связанные с ними задачи. Это позволяет оптимизировать процесс управления инструкциями и своевременно реагировать на изменения.

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

Для всех отчётов доступны настройка отборов и фильтров. Можно изменять структуру, сохранять и распечатывать отчеты типовыми средствами платформы «1С:Предприятие».

Загрузка сведений об объектах конфигурации

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

Для загрузки объектов конфигурации из другой базы необходимо скачать обработку «Загрузка объектов» по ссылке в форме загрузчика «Реестра функций».

При открытии обработки в исходной конфигурации выбираются объекты для переноса. Далее кнопкой «Выгрузить» формируется JSON-файл с перечислением выбранных объектов.

Полученный текст копируется и вставляется в обработку загрузчика в базе-получателе. После нажатия кнопки «Загрузить» выбранные объекты будут импортированы.

Условия использования инструментов «1С‑Рарус»

Команда разработки «1С‑Рарус» приглашает к обсуждению инструментов и пожеланий к их развитию на форум «1С‑Рарус».

Все желающие могут принять участие в развитии и сопровождении инструментов: github.com/rarus/dataeditor/blob/main/CONTRIBUTING.md.

Ознакомиться с другими инструментами «1С-Рарус»