Техническая документация

Структуру и оформление документа устанавливают в соответствии с ГОСТ 19.105-78.

Составление информационной части (аннотации и содержания) является обязательным [из п. 2 ГОСТ 19.502-78]

Текст документа должен состоять из следующих разделов:

• назначение программы ;
• условия применения ;
• описание задачи ;
• входные и выходные данные .

[из п. 3 ГОСТ 19.502-78]

В зависимости от особенностей программы допускается вводить дополнительные разделы или объединять отдельные разделы [из п. 4 ГОСТ 19.502-78]

Назначение программы

В разделе «Назначение программы» указывают назначение , возможности программы , ее основные характеристики , ограничения, накладываемые на область применения программы [из п. 5 ГОСТ 19.502-78]

Условия применения

В разделе «Условия применения» указываются условия, необходимые для выполнения программы (требования к необходимым для данной программы техническим средствам , и другим программам , общие характеристики входной и выходной информации , а также требования и условия организационного, технического и технологического характера и т.п.) [из п. 6 ГОСТ 19.502-78]

Описание задачи

В разделе «Описание задачи» должны быть указаны определения задачи и методы ее решения [из п. 7 ГОСТ 19.502-78]

Входные и выходные данные

В разделе «Входные и выходные данные» должны быть указаны сведения о входных и выходных данных [из п. 7а ГОСТ 19.502-78]

Приложения

В приложение к общему описанию могут быть включены справочные материалы (иллюстрации, таблицы, графики, примеры и т.п.) [из п. 8 ГОСТ 19.502-78]