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

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

6.1.7.Установление процедуры документирования

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

Процедуры определяют последовательность документирования:

планирование;
подготовка;
конфигурационное управление;
проверка;
утверждение;
производство;
хранение; дублирование;
распространение и модернизация; продажа.

Процедуры также должны определять контрольные пункты и методы обеспечения качества.

6.1.8.Распределение ресурсов для документирования

Основными ресурсами, требуемыми для документирования, являются следующие:

персонал;
средства;
финансирование.

6.1.8.1.Персонал

Для процесса разработки программного обеспечения необходимы люди со знанием:

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

6.1.8.2.Средства

Важно предусмотреть обеспечение задач документирования соответствующими и подходящими средствами.

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

6.1.8.3.Финансирование

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

6.1.9.Планирование документирования

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

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

План документирования должен быть доведен до всех участников разрабатывающего коллектива и до всех, кого он касается. Должны быть четко установлены обязанности всех вовлеченных в работу, связанную с документированием.

План должен включать в себя изложение:

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

График документирования должен распределять время для:

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

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

6.2.Требования к содержанию документов на автоматизированные системы

Требования к содержанию документов изложены в РД 50-34.698-90. Настоящие методические указания распространяются на автоматизированные системы (АС), используемые в различных сферах деятельности (управление, исследование, проектирование и т. п.), включая их сочетание, и устанавливают требования к содержанию документов, разрабатываемых при создании АС.

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

Требования к содержанию документов, разрабатываемых при создании АС, установлены настоящими указаниями, а также соответствующими государственными стандартами Единой системы программной документации (ЕСПД), Единой системы конструкторской документации (ЕСКД), Системы проектной документации для строительства (СПДС) и ГОСТ 34.602.

Виды и комплектность документов регламентированы ГОСТ 34.201.

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

Содержание каждого документа, разрабатываемого при проектировании АС согласно ГОСТ 34.201, определяет разработчик в зависимости от объекта проектирования (системы, подсистема и т.д.).

Содержание документов, разрабатываемых на предпроектных стадиях по ГОСТ 34.601, и организационно-распорядительных, определяют разработчики в зависимости от объема информации, необходимой и достаточной для дальнейшего использования документов.

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

6.2.2.Требования к содержанию документов по общесистемным решениям

6.2.2.1.Ведомость эскизного (технического) проекта

Ведомость содержит перечень всех документов, разработанных на соответствующих стадиях создания АС и применяемых из проектов других АС. Ведомость заполняют по разделам - частям проекта АС. Документ выполняется по ГОСТ 2.106. Наименования разделов и подразделов записывают в графах "Обозначение" и "Наименование" в виде заголовков и выделяют подчеркиванием.

6.2.2.2.Пояснительные записки к эскизному, техническому проектам

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

1) общие положения;

2) описание процесса деятельности;

3) основные технические решения;

4) мероприятия по подготовке объекта автоматизации к вводу системы в действие.

В разделе "Общие положения" приводят:

1) наименование проектируемой АС и наименования документов, их номера и дату утверждения, на основании которых ведут проектирование АС;

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

3) цели, назначение и области использования АС;

4) подтверждение соответствия проектных решений действующим нормам и правилам техники безопасности, пожаро- и взрывобезопасности и т. п.;

5) сведения об использованных при проектировании нормативно-технических документах;

6) сведения о НИР, передовом опыте, изобретениях, использованных при разработке проекта;

7) очередность создания системы и объем каждой очереди.

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

В разделе "Основные технические решения" приводят:

1) решения по структуре системы, подсистем, средствам и способам связи для информационного обмена между компонентами системы, подсистем:

2) решения по взаимосвязям АС со смежными системами, обеспечению ее совместимости;

3) решения по режимам функционирования, диагностированию работы системы;

4) решения по численности, квалификации и функциям персонала АС, режимам его работы, порядку взаимодействия;

5) сведения об обеспечении заданных в техническом задании (ТЗ) потребительских характеристик системы (подсистем), определяющих ее качество;

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

7) решения по комплексу технических средств, его размещению на объекте;

8) решения по составу информации, объему, способам ее организации, видам машинных носителей, входным и выходным документам и сообщениям, последовательности обработки информации и другим компонентам;

9) решения по составу программных средств, языкам деятельности, алгоритмам процедур и операций и методам их реализации.

В разделе "Мероприятия по подготовке объекта автоматизации к вводу системы в действие" приводят:

1) мероприятия по приведению информации к виду, пригодному для обработки на ЭВМ;

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

3) мероприятия по созданию необходимых подразделений и рабочих мест;

4) мероприятия по изменению объекта автоматизации;

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

6.2.2.3.Схема функциональной структуры

Документ "Схема функциональной структуры" содержит:

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

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

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

6.2.2.4.Описание автоматизируемых функций

Документ "Описание автоматизируемых функций" содержит разделы:

1) исходные данные;

2) цели АС и автоматизированные функции;

3) характеристика функциональной структуры;

4) типовые решения (при наличии).

В разделе "Исходные данные" приводят:

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

2) особенности объекта управления, влияющие на проектные решения по автоматизированным функциям;

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

4) описание информационной модели объекта вместе с его системой управления.

В разделе "Цели АС и автоматизированные функции" приводят описание автоматизированных функций, направленных на достижение установленных целей.

Раздел "Характеристика функциональной структуры" содержит:

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

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

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

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

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

6.2.2.5.Описание постановки задачи (комплекса задач)

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

1) характеристики комплекса задач;

2) выходная информация;

3) входная информация.

В разделе "Характеристики комплекса задач" приводят:

1) назначение комплекса задач;

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

3) периодичность и продолжительность решения;

4) условия, при которых прекращается решение комплекса задач автоматизированным способом (при необходимости);

5) связи данного комплекса задач с другими комплексами (задачами) АС;

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

7) распределение действий между персоналом и техническими средствами при различных ситуациях решения комплекса задач.

Раздел "Выходная информация" содержит:

1) перечень и описание выходных сообщений;

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

В описании по каждому выходному сообщению следует указывать:

1) идентификатор;

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

3) периодичность выдачи;

4) сроки выдачи и допустимое время задержки решения;

5) получателей и назначение выходной информации.

В описании по каждой структурной единице информации следует указывать:

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

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

3) требования к точности и надежности вычисления (при необходимости).

Раздел "Входная информация" должен содержать:

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

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

В описании по каждой структурной единице информации входных сообщений следует указывать;

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

2) требуемую точность ее числового значения (при необходимости);

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

4) идентификатор источника информации.

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