Руководство системного программиста
Лекция 73
Документация к сопровождению
На каждый программный продукт должна разрабатываться документация двух типов: для пользователей различных групп и для разработчиков. Отсутствие документации любого типа не допустимо.
При подготовке документации не следует забывать, что она разрабатывается для того, чтобы ее можно было использовать, и потому она должна содержать все необходимые сведения.
К программным относят документы, содержащие сведения, необходимые для разработки, сопровождения и эксплуатации программного обеспечения. Документирование программного обеспечения осуществляется в соответствии с единой системой программной документации (ГОСТ 19.ХХХ). ГОСТ 19.101-77 устанавливает виды программных документов для программного обеспечения различных типов.
Спецификация должна содержать перечень и краткое описание назначения всех файлов программного обеспечения, в том числе и файлов документации на него, и является обязательной для программных систем, а также их компонентов, имеющих самостоятельное применение.
Ведомость держателей подлинников (код вида документа - 05) должна содержать список предприятий, на которых хранятся подлинники программных документов. Необходимость этого документа определяется на этапе разработки и утверждения технического задания только для программного обеспечения со сложной архитектурой.
|
|
|
Текст программы (код вида документа - 12) должен содержать текст программы с необходимыми комментариями. Необходимость этого документа определяется на этапе разработки и утверждения технического задания.
Описание программы (код вида документа - 13) должно содержать сведения о логической структуре и функционировании программы. Необходимость этого документа определяется на этапе разработки и утверждения технического задания.
Ведомость эксплуатационных документов (код вида документа - 20) должна содержать перечень эксплуатационных документов на программу, к которым относятся документы с кодами: 30, 31, 32, 33, 34, 35, 46. Необходимость этого документа определяется на этапе разработки и утверждения технического задания.
Формуляр (код вида документа - 30) должен содержать основные характеристики программного обеспечения, комплектность и сведения об эксплуатации программы.
Описание применения (код вида документа - 31) должно содержать сведения о назначении программного обеспечения, области применения, применяемых методах, классе решаемых задач, ограничениях для применения, минимальной конфигурации технических средств.
Руководство системного программиста (код вида документа - 32) должно содержать сведения для проверки, обеспечения функционирования и настройки программы на условия конкретного применения.
|
|
|
Руководство программиста (код вида документа - 33) должно содержать сведения для эксплуатации программного обеспечения.
Руководство оператора (код вида документа - 34) должно содержать сведения для обеспечения процедуры общения оператора с вычислительной системой в процессе выполнения программного обеспечения.
Описание языка (код вида документа - 35) должно содержать описание синтаксиса и семантики языка.
Руководство по техническому обслуживанию (код вида документа - 46) должно содержать сведения для применения тестовых и диагностических программ при обслуживании технических средств.
Программа и методика испытаний (код вида документа - 51) должны содержать требования, подлежащие проверке при испытании программного обеспечения, а также порядок и методы их контроля.
Пояснительная записка (код вида документа - 81) должна содержать информацию о структуре и конкретных компонентах программного обеспечения, в том числе схемы алгоритмов, их общее описание, а также обоснование принятых технических и технико-экономических решений. Составляется на стадии эскизного и технического проекта.
|
|
|
Прочие документы (коды вида документа – 90-99) могут составляться на любых стадиях разработки, т.е. на стадиях эскизного, технического и рабочего проектов.
Допускается объединять отдельные виды эксплуатационных документов, кроме формуляра и ведомости. Необходимость объединения указывается в техническом задании, а имя берут у одного из объединяемых документов. В настоящее время используется документ «Руководство пользователя», в который отчасти входит руководство системного программиста, программиста и оператора.
Пояснительная записка
Пояснительная записка должна содержать всю информацию, необходимую для сопровождения и модификации программного обеспечения: сведения о его структуре и конкретных компонентах, общее описание алгоритмов и их схемы, а также обоснование принятых технических и технико-экономических решений.
Содержание пояснительной записки по стандарту (ГОСТ 19.404-79):
- Введение;
- Назначение и область применения;
- Технические характеристики;
- Ожидаемые технико-экономические показатели;
- Источники, используемые при разработке.
В разделе Введение указывают наименование программы и документа, на основании которого ведется разработка.
|
|
|
В разделе Назначение и область применения указывают назначение программы и дают краткую характеристику области применения.
Раздел Технические характеристики должен содержать следующие подразделы:
- постановка задачи, описание применяемых математических методов и допущений и ограничений, связанных с выбранным математическим аппаратом;
- описание алгоритмов и функционирования программы с обоснованием принятых решений;
- описание и обоснование выбора способа организации входных и выходных данных;
- описание и обоснование выбора состава технических и программных средств на основании проведенных расчетов или анализов.
В разделе Ожидаемые технико-экономические показатели указывают технико-экономические показатели, обосновывающие преимущество выбранного варианта технического решения.
В разделе Источники, использованные при разработке, указывают перечень научно-технических публикаций, нормативно-технических документов и других научно-технических материалов, на которые есть ссылки в исходном тексте.
Пояснительная записка составляется профессионалами в области разработки программного обеспечения и для специалистов того же уровня квалификации. В ней необходимо использовать специальную терминологию, ссылаться на специальную литературу и т.п.
Руководство пользователя
В настоящее время используется Руководство пользователя, в которое входят руководство системного программиста, программиста и оператора. Этот документ появился с распространением персональных компьютеров, работая на которых пользователи совмещают в своем лице трех указанных специалистов.
Составление документации для пользователей имеет свои особенности, связанные с тем, что пользователь, как правило, не является профессионалом в области разработки программного обеспечения.
Рекомендации по написанию подобной программной документации:
- учитывайте интересы пользователей – руководство должно содержать все инструкции, необходимые пользователю;
- излагайте ясно, используйте короткие предложения;
- избегайте технического жаргона и узко специальной терминологии, если все же необходимо использовать некоторые термины, то их следует пояснить;
- будьте точны и рациональны – длинные и запутанные руководства обычно никто не читает, например, лучше привести рисунок формы, чем долго ее описывать.
Руководство пользователя содержит следующие разделы:
- общие сведения о программном продукте;
- описание установки;
- описание запуска;
- инструкции по работе (или описание пользовательского интерфейса);
- сообщения пользователю.
Раздел Общие сведения о программе обычно содержит наименование программного продукта, краткое описание его функций, реализованных методов и возможных областей применения.
Раздел Установка содержит подробное описание действий по установке программного продукта и сообщений, которые при этом могут быть получены.
В разделе Запуск описаны действия по запуску программного продукта и сообщений, которые при этом могут быть получены.
Раздел Инструкция по работе обычно содержит описание режимов работы, форматов ввода-вывода информации и возможных настроек.
Раздел Сообщения пользователю должен содержать перечень возможных сообщений, описание их содержания и действий, которые необходимо предпринять по этим сообщениям.
Руководство системного программиста
По ГОСТ 19.503-79 руководство системного программиста должно содержать всю информацию, необходимую для установки программного обеспечения, его настройки и проверки работоспособности. В него часто включают и описание необходимого обслуживания, которое раньше приводилось в руководстве оператора и руководстве по техническому обслуживанию.
Руководство системного программиста должно содержать следующие разделы:
- общие сведения о программном продукте,
- структура,
- настройка,
- проверка,
- дополнительные возможности,
- сообщения системному программисту.
Раздел Общие сведения о программе должен включать описание назначения и функций программы, а также сведения о технических и программных средствах, обеспечивающих выполнение данной программы (например, объем оперативной памяти, требования к составу и параметрам внешних устройств, требования к программному обеспечению и т.п.).
В разделе Структура программы должны быть приведены сведения о структуре программы, ее составных частях, о связях между составными частями и о связях с другими программами.
В разделе Настройка программы должно быть приведено описание действий по настройке программы на условия практического применения.
В разделе Проверка программы должно быть приведено описание способов проверки работоспособности программы, например контрольные примеры.
В разделе Дополнительные возможности должно быть приведено описание дополнительных возможностей программы и способов доступа к ним.
В разделе Сообщения системному программисту должны быть указаны тексты сообщений, выдаваемых в ходе выполнения настройки и проверки программы, а также в ходе его выполнения, описание их содержания и действий, которые необходимо предпринять по этим сообщениям.
Дата добавления: 2020-11-29; просмотров: 512; Мы поможем в написании вашей работы! |
Мы поможем в написании ваших работ!