Пояснительная записка
Пояснительная записка должна содержать всю информацию, необходимую для сопровождения и модификации программного обеспечения: сведения о его структуре и конкретных компонентах, общее описание алгоритмов и их схемы, а также обоснование принятых технических и технико-экономических решений.
Содержание пояснительной записки по стандарту (ГОСТ 19.404—79) должно включать следующие разделы:
• введение;
• назначение и область применения;
• технические характеристики;
• ожидаемые технико-экономические показатели;
• источники, используемые при разработке.
В разделе Введение указывают наименование программы и документа, на основании которого ведется разработка.
В разделе Назначение и область применения указывают назначение программы и дают краткую характеристику области применения.
Раздел Технические характеристики должен содержать следующие подразделы:
• постановку задачи, описание применяемых математических методов и допущений и ограничений, связанных с выбранным математическим аппаратом;
|
|
• описание алгоритмов и функционирования программы с обоснованием принятых решений;
• описание и обоснование выбора способа организации входных и выходных данных;
• описание и обоснование выбора состава технических и программных средств на основании проведенных расчетов или анализов.
В разделе Ожидаемые технико-экономические показатели указывают технико-экономические показатели, обосновывающие преимущество выбранного варианта технического решения.
В разделе Источники, использованные при разработке, указывают перечень научно-технических публикаций, нормативнотехнических документов и других научно-технических материалов, на которые есть ссылки в исходном тексте.
Пояснительная записка составляется профессионалами в области разработки программного обеспечения для специалистов того же уровня квалификации. Следовательно, в ней уместно использовать специальную терминологию, ссылаться на специальную литературу и т. п.