Библиотеки взаимоувязанных документов представляют особый интерес при обратной разработке. И не только - библиотеки взаимоувязанных документов позволяют документировать с самых различных «точек входа», с любой стадии или этапа жизненного цикла.
Обратимся ко всеми любимой педевикии, поскольку стандарты всегда несколько отстают от образования некоторой сущности или «новой формулы». Итак, «Обратная разработка (обратный инжиниринг, реверс-инжиниринг; англ. reverse engineering) - исследование некоторого изделия или программы, а также документации на него с целью понять принцип его работы и, чаще всего, воспроизвести устройство, программу или иной объект с аналогичными функциями, но без копирования как такового.». И начнем воспроизводить. Редакция от 13.11.2021.
Создан 10.11.2020 12:43:28
На этом древнем рисунке, за прошедшие 16 лет так и не потерявшем своей актуальности, изображен процесс документирования «от технического задания». Но есть ли принципиальная разница, с какого именно документа начинать, если все разделы-подразделы-пункты-подпункты давным давно взаимоувязаны? Тем более, что отсутствуют противоречия с действующими стандартами, к примеру, «Документ «Описание постановки задачи» предназначен для описания характеристик комплекса задач (задачи), условий, необходимых для его решения, входной и выходной информации и совместно с «Техническим заданием» на создание АСУ определяет требования к видам обеспечения АСУ [из 1.1 ГОСТ 24.204-80]»? Здесь ключевое словосочетание - «совместно с».
Можно смело открыть в библиотеке взаимоувязанных документов книгу «Описание постановки задачи» и начать заполнять любой из ее топиков, например «_1.2_1 назначение основного комплекса задач [из п. 2.2 ГОСТ 24.204-80]»:
Получение позиции ссылки на текущую страницу в результатах поиска информационно-поисковых систем (поисковых машин, сервисов) Яндекс.Поиск и Google требуется для выяснения причин снижения посещаемости страницы конечными пользователями.
А на выходе, - «как-нибудь так, незаметно, само собой...» - будут автоматически формироваться взаимоувязанные документы библиотеки, перечень которых изображен на рисунке ниже.
Вот и ссылки прямо на этот топик в их структуре:
- 1.2 Информация, достаточная для понимания функций программы и ее эксплуатации (Руководство оператора);
- 1.2 Функции, выполняемые программой (Руководство программиста);
- 3.1 Определения задачи (Описание применения);
- 1.2 Назначение комплекса задач (Описание постановки задачи ГОСТ 24.204-80).
Что характерно: если в распоряжении документатора или технического писателя имеется только интерфейс программы, то при создании описания его в Руководстве оператора будут автоматически создаваться не только Описание постановки задачи, Описание применения и Руководство программиста из взаимоувязанной библиотеки, но и сами стадии и этапы разработки по ГОСТ 19.102-77. Та самая обратная разработка или reverse engineering, в ходе которой сначала «всплывают» функции программы, которые объединяются в задачи, затем задачи объединяются в комплексы задач, а на выходе получается полноценное техническое задание и, что самое главное - полная структура декомпозиции работ по проекту.