3.4 Оценка руководства программиста
Разработанное руководство программиста подлежит оценке на соответствие требованиям ГОСТ 19.503–79 [11].
Руководство программиста выполняет важную функцию передачи технической информации между разработчиками, тестировщиками и специалистами сопровождения. Полные критерии оценивания представлены на рисунке 3.4.
Рисунок 3.4 – Критерии оценки руководства программиста
Документ также получил максимальную оценку – 15 баллов из 15 – и демонстрирует высокую степень соответствия структуре ГОСТ 19.503–79. Полноценные результаты оценки представлены в таблице 3.4.
Таблица 3.4 – Результаты оценки руководства пользователя
Критерий |
Описание критерия |
Разбалловка |
Макс. балл |
Выст. балл |
Комментарий к оценке |
|||||
Соответствие стандарту |
Оформление по требованиям ГОСТ |
0–1 |
1 |
1 |
Структура соответствует ГОСТ 19.505‑79; имеются мелкие стилистические погрешности (строчные «windows», «.net»). |
|||||
Назначение программы |
Назначение и область применения |
0–2 |
2 |
2 |
Раздел 1 чётко определяет назначение (поиск подстроки методом КМП) и области применения (учебные, исследовательские и прикладные задачи). |
|||||
Условия применения |
Требования к техническим и программным средствам |
0–2 |
2 |
2 |
Разделы 1.1 и 1.2, таблицы 1 и 2 охватывают требования к CPU, ОЗУ, диску, ОС, .NET 6.0 Runtime, WinForms, форматам логов. |
|||||
Характеристика программы |
Структура программы, модули и их взаимодействие |
0–2 |
2 |
2 |
Раздел 2 описывает структуру: GUI, модуль валидации, ядро КМП, подсистема журналирования и проверки зависимостей. |
|||||
Порядок запуска и завершения работы |
Запуск, выполнение и завершение |
0–2 |
2 |
2 |
Раздел 3 раскрывает полный цикл работы: запуск KMP.exe, самотест, авторизация, выполнение поиска, корректное завершение с очисткой временных данных. |
|||||
Входные и выходные данные |
Описание входных и выходных данных |
0–2 |
2 |
2 |
В разделе 4 приведены таблицы входных данных (строка, подстрока) и выходных результатов (позиция, сообщения), с форматами и ограничениями длины. |
|||||
Описание обработки ошибок |
Поведение при ошибках и исключениях |
0–2 |
2 |
2 |
В п. 3.1–3.2 и разделе 5 описаны пользовательские сообщения об ошибках и формат логов /logs/kmp_log.txt, что обеспечивает разработчика диагностической информацией. |
|||||
Продолжение таблицы 3.4.
Критерий |
Описание критерия |
Разбалловка |
Макс. балл |
Выст. балл |
Комментарий к оценке |
Понятность для разработчика |
Возможность понять структуру без автора |
0–2 |
2 |
2 |
Документ достаточен для того, чтобы сторонний разработчик смог развернуть, протестировать и сопровождать программу без обращения к автору. |
ИТОГО |
|
|
15 |
15 |
|
Назначение программы и области её применения сформулированы чётко, условия эксплуатации детализированы в таблицах с указанием требований к процессору, оперативной памяти, дисковому пространству, версиям ОС и фреймворков. Характеристика программы раскрывает внутреннюю архитектуру: выделены графический интерфейс, модуль валидации, ядро алгоритма КМП, подсистема журналирования и механизм проверки зависимостей. Порядок запуска и завершения работы описан в полном цикле, включая самотестирование, авторизацию, выполнение поиска и корректную очистку временных данных.
Входные и выходные данные структурированы в таблицах с указанием форматов и ограничений, а обработка ошибок раскрыта через пользовательские сообщения и формат лог-файла /logs/kmp_log.txt, что обеспечивает разработчика достаточным объёмом диагностической информации.
Несмотря на незначительные стилистические погрешности, документ обладает высокой информационной плотностью и позволяет стороннему специалисту развернуть, протестировать и сопровождать систему без обращения к первоначальному автору.