Руководство системного программиста

По ГОСТ 19.503-79 руководство системного программиста должно содержать всю информацию, необходимую для установки программного обеспечения, его настройки, проверки работоспособности. Кроме того в него часто включают т описание необходимого обслуживания. Руководство системного программиста должно содержать следующие разделы:

· общие сведения о программном продукте;

· структура;

· настройка;

· проверка;

· дополнительные возможности;

· сообщения системному программисту.

Раздел Общие сведения о программе должен включать описание назначения и функций программы, а также сведения о технических и программных средствах, обеспечивающих выполнение данной программы (например, объём оперативной памяти, требования к составу и параметрам технических устройств, требования к программному обеспечению и т. п.).

В разделе Структура программы должны быть приведены сведения о структуре программы, её составных частях, о связях ме жду составными частями и о связях с другими программами.

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

В разделе Проверка программы должно быть приведено описание способов проверки работоспособности программы, например контрольные примеры.

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

В разделе Сообщения системному программисту должны быть указаны тексты сообщений, выдаваемых в ходе выполнения настройки и проверки программы, описание их содержания и действий, которые необходимо предпринимать по этим сообщениям.

Список литературы

Список литературы должен включать все использованные источники. Сведения о книгах (монографиях, учебниках, пособиях, справочниках и т.д.) должны содержать: фамилия и инициалы автора, заглавие книги, место издания, издательство, год издания. При наличии трёх и более авторов допускается указывать фамилию и инициалы только первого из них со словами «и др.» Издательство надо приводить полностью в именительном падеже: допускается сокращение названия только двух городов: Москва (М.) и Санкт-Петербург (СПб).

Сведения о статье из периодического издания должны включать: фамилию и инициалы автора, наименование статью, издания (журнала), серии (если она есть), год выпуска, том (если есть), номер издания (журнала) и номера страниц, на которых помещена статья.

Присылке на источник из списка литературы надо указывать порядковый номер по списку литературы, заключённый в квадратные скобки.

Приложения

Приложения должны содержать материал, не вошедший в документ по причине его ограниченного объёма, но интересный для более глубокого понимания излагаемого материала.

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