Содержание документов сопровождения

Пояснительная записка

Пояснительная записка должна содержать всю информацию, необходимую для сопровождения и модификации программного обеспечения: сведения о его структуре и конкретных компонен­тах, общее описание алгоритмов и их схемы, а также обоснова­ние принятых технических и технико-экономических решений.

Содержание пояснительной записки по стандарту (ГОСТ 19.404—79) должно включать следующие разделы:

• введение;

• назначение и область применения;

• технические характеристики;

• ожидаемые технико-экономические показатели;

• источники, используемые при разработке.

В разделе Введение указывают наименование программы и документа, на основании которого ведется разработка.

В разделе Назначение и область применения указывают назна­чение программы и дают краткую характеристику области при­менения.

Раздел Технические характеристики должен содержать сле­дующие подразделы:

• постановку задачи, описание применяемых математиче­ских методов и допущений и ограничений, связанных с выбранным математическим аппаратом;

• описание алгоритмов и функционирования программы с обоснованием принятых решений;

• описание и обоснование выбора способа организации вход­ных и выходных данных;

• описание и обоснование выбора состава технических и про­граммных средств на основании проведенных расчетов или анализов.

В разделе Ожидаемые технико-экономические показатели ука­зывают технико-экономические показатели, обосновывающие преимущество выбранного варианта технического решения.

В разделе Источники, использованные при разработке, указы­вают перечень научно-технических публикаций, нормативно­технических документов и других научно-технических материа­лов, на которые есть ссылки в исходном тексте.

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