Сопроводительная документация программного продукта

Общие сведения

Программная система для учебно-методического комплекса по изучению схемотехники аналоговых устройств разработана для эксплуатации в МИЭМ НИУ ВШЭ.

В настоящее время российская экономика ориентирована на разработку и внедрение, как на внутреннем, так и на внешнем рынке продукции высоких технологий, включая разработку аппаратно-программных комплексов (АПК), автоматизированных систем (АС) и программных продуктов (ПП). Существенно возросло число отечественных предприятий, выполняющих различные работы по упомянутым направлениям.

Неотъемлемой частью любой организации-разработчика программного обеспечения (ПО) является разработка технической документации (ТД).

Текстовые документы подразделяют на документы, содержащие в основном сплошной текст (технические условия, паспорта, расчеты, пояснительные записки, инструкции и т. п.) и документы, содержащие текст, разбитый на графы (спецификации, ведомости, таблицы и т. п.)[15].

Основным нормативным документом, определяющим правоотношения в сфере программного обеспечения, является комплекс стандартов ГОСТ 19. — Единая система программной документации. Данным документом установлены требования, которые регламентируют разработку, изготовление и эксплуатацию программ и программных документов. Стандарты ЕСПД содержат правила и положения, распространяющиеся на программы и программную документацию (ПД) для вычислительных машин, комплексов и систем независимо от их назначения и области применения. Виды программ и программных документов определяют основные термины, относящиеся к программным продуктам и документам [17].

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

Для работы с программой необходимо завести сотрудника в базе и установить для него логин и парол[18].

Чтобы начать работать с программой, необходимо проверить наличие следующих файлов и каталогов:

• — каталог «Excel-files» предназначен для хранения результатов тестирования в формате excel;
• — каталог «Patterns» предназначен для хранения шаблона, который используется для формирования отчета о результате тестирования в формате word;
• — каталог «Word-files» предназначен для хранения результатов тестирования в формате word;
• — каталог «Лекции» предназначен для хранения файлов с лекциями в форматах: doc, docx, xls, txt, pdf;
• — каталог «Параметры» предназначен для хранения файла «Путь_к_лекциям.nnn», в котором содержится путь к каталогу с лекциями;
• — каталог «Тестирование» предназначен для хранения отчетов о результате тестирования с подробным указанием информации, как отвечал студент на каждый вопрос теста, и какой балл был заработан.