Документирование программных средств ВИДЫ ПРОГРАММНЫХ ДОКУМЕНТОВ

Документирование программных средств

ВИДЫ ПРОГРАММНЫХ ДОКУМЕНТОВ • К программным относят документы, содержащие сведения, необходимые для разработки, сопровождения и эксплуатации программного обеспечения. • Документирование программного обеспечения осуществляется в соответствии с Единой системой программной документации (ГОСТ 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) могут составляться на любых стадиях разработки, т. е. на стадиях эскизного, технического и рабочего проектов.

Документация, создаваемая в процессе разработки программных средств

• При разработке ПС создается большой объем разнообразной документации. Она необходима как средство передачи информации между разработчиками ПС, как средство управления разработкой ПС и как средство передачи пользователям информации, необходимой для применения и сопровождения ПС. На создание этой документации приходится большая доля стоимости ПС.

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

• Документы управления разработкой ПС (process documentation), протоколируют процессы разработки и сопровождения ПС, обеспечивая связи внутри коллектива разработчиков и между коллективом разработчиков и менеджерами (managers) лицами, управляющими разработкой.

Документы управления разработкой: • Планы, оценки, расписания. Эти документы создаются менеджерами для прогнозирования и управления процессами разработки и сопровождения. • Отчеты об использовании ресурсов в процессе разработки. Создаются менеджерами. • Стандарты. Эти документы предписывают разработчикам, каким принципам, правилам, соглашениям они должны следовать в процессе разработки ПС. Эти стандарты могут быть как международными или национальными, так и специально созданными для организации, в которой ведется разработка данного ПС.

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

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

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

ПОЯСНИТЕЛЬНАЯ ЗАПИСКА • Пояснительная записка должна содержать всю информацию, необходимую для сопровождения и модификации программного обеспечения: сведения о его структуре и конкретных компонентах, общее описание алгоритмов и их схемы, а также обоснование принятых технических и технико экономических решений.

ПОЯСНИТЕЛЬНАЯ ЗАПИСКА • Содержание пояснительной записки по стандарту (ГОСТ 19. 404 79) должно выглядеть следующим образом: • • введение; • • назначение и область применения; • • технические характеристики; • • ожидаемые технико экономические показатели; • • источники, используемые при разработке.

ПОЯСНИТЕЛЬНАЯ ЗАПИСКА • В разделе Введение указывают наименование программы и документа, на основании которого ведется разработка. • В разделе Назначение и область применения указывают назначение программы и дают краткую характеристику области применения.

ПОЯСНИТЕЛЬНАЯ ЗАПИСКА • Раздел Технические характеристики должен содержать следующие подразделы: • • постановка задачи, описание применяемых математических методов и допущений и ограничений, связанных с выбранным математическим аппара том; • • описание алгоритмов и функционирования программы с обоснованием принятых решений; • • описание и обоснование выбора способа организации входных и выходных данных; • • описание и обоснование выбора состава технических и программных средств на основании проведенных расчетов или анализов.

ПОЯСНИТЕЛЬНАЯ ЗАПИСКА • В разделе Ожидаемые техникоэкономические показатели указывают технико экономические показатели, обосновывающие преимущество выбранного варианта технического решения. • В разделе Источники, использованные при разработке, указывают перечень научно технических публикаций, нормативно технических документов и других научно технических материалов, на которые есть ссылки в исходном тексте.

ПОЯСНИТЕЛЬНАЯ ЗАПИСКА • Пояснительная записка составляется профессионалами в области разработки программного обеспечения и для специалистов того же уровня квалификации. Следовательно, в ней уместно использовать специальную терминологию, ссылаться на специальную литературу и т. п.

Самостоятельная работа • • Сделать постановку задачи Разработать спецификации Написать программный код Написать пояснительную записку

Задания • Найти ГОСТы: – ГОСТ 19. 101 77, – ГОСТ 19. 404 79, – ГОСТ 19. 402 – 78, – ГОСТ 19. 301 – 79 • Изучить их • Составить документы в соответствии с этими ГОСТами