Файл: Учебное пособие.doc

В разделе "Постановка задачи" указывают основные пути и направления решения задачи, требования и ограничения на решение, критерии оценки результатов.

В разделе "Методика проектирования" описывают выбранные математические методы, используемые при проектировании, указывают состав и назначение проектных процедур, порядок взаимодействия проектных процедур в процессе выполнения.

В разделе "Исходные данные" определяют состав, порядок выбора, представления и формирования массивов используемой информации, перечень обозначений элементов, описывающих предметную область, с указанием их наименований, единиц измерений, диапазона изменения значений, критерии оценки исходных данных, выбирают методы и модели решения.

В разделе "Проектные процедуры" указывают по каждой проектной процедуре состав нормативно-справочных входных данных, правила доступа к ним, порядок выполнения процедуры, состав и форму выходных сообщений.

В разделе "Оценка результатов" приводят анализ полученного проектного решения на соответствие заданным критериям.

При проектировании конкретных объектов документ "Методика автоматизированного проектирования" может быть дополнен специфическими разделами, характерными для проектируемых объектов.

6.2.3.3.Технологическая инструкция

Документ "Технологическая инструкция" разрабатывают на операцию или комплекс операций технологического процесса обработки данных.

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

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

6.2.3.4.Руководство пользователя

Документ содержит разделы:

1) введение;

2) назначение и условия применения;

3) подготовка к работе;

4) описание операций;

5) аварийные ситуации;

6) рекомендации по освоению.

В разделе "Введение" указывают:

1) область применения;

2) краткое описание возможностей;

3) уровень подготовки пользователя;

4) перечень эксплуатационной документации, с которыми необходимо ознакомиться пользователю.

В разделе "Назначение и условия применения" указывают:

1) виды деятельности, функции, для автоматизации которых предназначено данное средство автоматизации;

2) условия, при соблюдении (выполнении, наступлении) которых обеспечивается применение средства автоматизации в соответствии с назначением (например, вид ЭВМ и конфигурация технических средств, операционная среда и общесистемные программные средства, входная информация, носители данных, база данных, требования к подготовке специалистов и т. п.).

В разделе "Подготовка к работе" указывают:

1) состав и содержание дистрибутивного носителя данных;

2) порядок загрузки данных и программ;

3) порядок проверки работоспособности.

В разделе "Описание операций" указывают:

1) описание всех выполняемых функций, задач, комплексов задач, процедур;

2) описание операций технологического процесса обработки данных, необходимых для выполнения функций, комплексов задач (задач), процедур.

Для каждой операции обработки данных указывают:

1) наименование;

2) условия, при соблюдении которых возможно выполнение операции;

3) подготовительные действия;

4) основные действия в требуемой последовательности;

5) заключительные действия;

6) ресурсы, расходуемые на операцию.

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

В разделе "Аварийные ситуации" указывают:

1) действия в случае несоблюдения условий выполнения технологического процесса, в том числе при длительных отказах технических средств;

2) действия по восстановлению программ и/или данных при отказе магнитных носителей или обнаружении ошибок в данных;

3) действия в случаях обнаружении несанкционированного вмешательства в данные;

4) действия в других аварийных ситуациях.

В разделе "Рекомендации по освоению" указывают рекомендации по освоению и эксплуатации, включая описание контрольного примера, правила его запуска и выполнения.

6.2.3.5.Описание технологического процесса обработки данных

Документ содержит разделы:

1) технологический процесс сбора и обработки данных на периферийных устройствах при децентрализованной обработки данных;

2) технологический процесс обработки данных на вычислительном центре.

В разделе "Технологический процесс сбора и обработки данных на периферийных устройствах при децентрализованной обработки данных" указывают:

1) состав и последовательность выполнения технологических операций по сбору, регистрации, подготовке, контролю, передаче, обработке и отображению информации;

2) перечень документации, сопровождающей каждую операцию в данном технологическом процессе.

В разделе "Технологический процесс обработки данных на вычислительном центре" указывают:

1) состав и последовательность выполнения технологических операций по приему, контролю, обработке, хранению, выдаче данных и других операций, выполняемых на вычислительном центре;

2) перечень документации, сопровождающей данный технологический процесс.

6.2.4.Требования к содержанию документов с решениями по программному обеспечению

6.2.4.1.Описание программного обеспечения

Документ содержит вводную часть и разделы:

1) структура программного обеспечения;

2) функции частей программного обеспечения;

3) методы и средства разработки программного обеспечения;

4) операционная система;

5) средства, расширяющие возможности операционной системы.

Во вводной части приводят основные сведения о техническом, информационном и других видах обеспечения АС, необходимые для разработки программного обеспечения или ссылку на соответствующие документы проекта АС.

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

В разделе "Функции частей программного обеспечения" приводят назначение и описание основных функций для каждой части программного обеспечения.

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

В разделе "Операционная система" указывают

1) наименование, обозначение и краткую характеристику выбранной операционной системы и ее версии, в рамках которой будут выполнять разрабатываемые программы, с обоснованием выбора и указанием источников, где дано подробное описание выбранной версии;

2) наименование руководства, в соответствии с которым должна осуществляться генерация выбранного варианта операционной системы;

3) требования к варианту генерации выбранной версии операционной системы.

Раздел "Средства, расширяющие возможности операционной системы" содержит подразделы, в которых для каждого используемого средства, расширяющего возможности операционной системы, указывают:

1) наименование, обозначение и краткую характеристику средства с обоснованием необходимости его применения и указанием источника, где дано подробное описание выбранного средства;

2) наименование руководства, в соответствии с которым следует настраивать используемое средство на конкретное применение;

3) требования к настройке используемого средства.

6.2.5.Другие разделы

Данный комплекс стандартов и руководящих документов предусматривает описание требований и к другим видам обеспечения:

• Требования к содержанию документов с решениями по техническому обеспечению

• Требования к содержанию документов с решениями по информационному обеспечению

• Требования к содержанию документов с решениями по математическому обеспечению

6.3.Принципы разработки руководства программиста

Требования к содержанию руководства программиста изложены в ГОСТ 19.504-79. Настоящий стандарт устанавливает требования к содержанию и оформлению программного документа «Руководство программиста».

6.3.1.Общие положения

Структуру и оформление документа устанавливают в соответствии с ГОСТ 19.105-78. Составление информационной части (аннотации и содержания) является обязательным. Руководство программиста должно содержать следующие разделы:

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

• характеристика программы;

• обращение к программе;

• входные и выходные данные;

• сообщения.

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

6.3.2.Содержание разделов

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

В разделе «Характеристика программы» должно быть приведено описание основных характеристик и особенностей программы (временные характеристики, режим работы, средства контроля правильности выполнения и самовосстанавливаемости программы и т.п.).

В разделе «Обращение к программе» должно быть приведено описание процедур вызова программы (способы передачи управления и параметров данных и др.).

В разделе «Входные и выходные данные» должно быть приведено описание организации используемой входной и выходной информации и, при необходимости, ее кодирования.

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

В приложении к руководству программиста могут быть приведены дополнительные материалы (примеры, иллюстрации, таблицы, графики и т.п.).

6.4.Разработка руководства пользователя

6.4.1.Общие замечания

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

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

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

Целесообразно дать иллюстрации в виде экранов с описанием особенностей манипуляций на клавиатуре.

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

Руководство пользователя содержит следующие разделы:

• общие сведения;

• описание применения;

• требования к процедурам.

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

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

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

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

Затем должны быть описаны требования, предъявляемые к каждому выходному документу или экрану. При этом должно быть указано: способ использования и частота выдачи, способ представления (носитель), инструкции по сохранению, распространению и т.д. В этом же разделе должны быть представлены описания всех выходных форм и экранов с объяснением каждого конкретного раздела формы. Для каждого типа результатов работы изделия должны быть представлены образцы с примерами результатов.