Размещено на http://www.allbest.ru/

Содержание

• Введение
• 1. Категории программной документации
• 2. Оформление документации на различных стадиях и этапах разработки
• 3. Правила оформления программной документации
• 4. Нормативные документы и госты
• Заключение
• Список использованных источников

Введение

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

Объект: Анализ оформления программной документации.

Предмет: Программная документация.

Цель: Рассмотреть правила оформления программной документации.

Задачи:

1. Рассмотреть категории и состав программной документации.

2. Рассмотреть стадии и этапы программной документации.

3. Рассмотреть правила оформления программной документации.

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

программный документация оформление нормативный

1. Категории программной документации

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

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

· Автор (или иной правообладатель) на определенных условиях позволяет распространять и использовать программу.

· Человек, получивший в распоряжение дистрибутив программы, сможет самостоятельно установить и полноценно применять ее.

Последний пункт имеет непосредственное отношение к технической документации.

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

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

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

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

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

· Внутренняя (технологическая) - используется в процессе разработки ПО и недоступна пользователю [2].

· Внешняя (пользовательская) - всевозможные руководства для пользователя [2].

Состав документации разработки программного продукта в значительной мере зависит от методологии, которую исповедует коллектив разработчиков. Каждая методология, скажем, RUP или MSF, предусматривает свой набор документов. Идеологически эти наборы во многом похожи, хотя одни и те же документы в них могут по-разному называться и иметь разную структуру. В Единой системе программной документации понятие документации разработки отсутствует, но как таковая она там предусмотрена. В табл. 1 приведен состав документации разработки согласно ЕСПД [4].

Таблица 1

Документация разработки программы согласно ЕСПД

Документ	Источник	Аудитория	Содержание
Техническое задание	Аналитик	Проектировщик ПО	Требования к программе
Пояснительная записка к техническому заданию	Проектировщик ПО	Программист	Устройство программы
Программа и методика испытаний	Аналитик	Представитель заказчика, осуществляющий приёмку программы	Процедура, позволяющая убедиться в соответствии программы техническому заданию

Состав комплекта эксплуатационной документации на программный продукт зависит от архитектуры последнего, назначения его компонентов и особенностей пользовательской аудитории. Наиболее распространенные типы эксплуатационных документов приведены в табл. 2 [6].

Таблица 2

Эксплуатационная документация на программный продукт

Документ	Аудитория	Примерное содержание
Описание программы	Лица, принимающие решения о приобретении, вводе в эксплуатацию и способах использования программы	Назначение и основные возможности программы, необходимые ей нее системные ресурсы, входные и выходные данные
Описание программы
Описание языка	Пользователи языка (программисты, операторы, кодеры, верстальщики)	Основная идея языка, его синтаксис, элементы и конструкции, встроенные функции
Паспорт	Лица, ответственные за эксплуатацию программы	Краткие сведения о программе и условиях ее поставки
Руководство администратора	Ответственный пользователь системы, обеспечивающий ее целевое применение	Управление учетными записями пользователей, назначение пользователям прав доступа, ведение нормативно-справочной информации, загрузка и выгрузка данных
Руководство оператора	Операторы, работающие с системой, частью которой является программа	Порядок выполнения предусмотренных операций, сообщения программы и предписанные оператору способы реакции на них
Руководство пользователя	Пользователи программы, т.е. лица, применяющие ее для решения собственных прикладных задач	Назначение и возможности программы, ее основные концепции, интерфейс пользователя, порядок решения типовых задач, описание функций программы
Руководство программиста	Программисты, сопровождающие программу или использующие ее в качестве платформы либо средства разработки при создании собственных программ	Архитектура программы или создаваемых на ее основе приложений, описание программных интерфейсов к ее объектам, протоколов обмена данными и т. п.
Руководство системного администратора (системного программиста)	Системные администраторы, осуществляющие установку программы и поддерживающие систему в рабочем состоянии	Установка программы, ее интеграция в систему, проверка правильности функционирования, устранение аварийных ситуаций
Спецификация	Лица, ответственные за эксплуатацию программы	Комплект поставки программы
Справочная система	Пользователи, операторы, администраторы, системные администраторы, программисты и др	Материал всех имеющихся руководств и описаний, краткие описания элементов интерфейса пользователя программы
Формуляр	Лица, ответственные за эксплуатацию программы	Краткие сведения о программе и условиях ее поставки, записи эксплуатационного о возникающих сбоях и прочих событиях такого рода

Таким образом, мы рассмотрели на какие категории деляют документацию. Ознакомились с документами, которые входят в Эксплутационную документацию и в документацию согласно ЕСПД.

2. Оформление документации на различных стадиях и этапах разработки

Стадия Техническое задание. Техническое задание - исходный документ на проектирование программного обеспечения (ПО). ТЗ устанавливает основное назначение разрабатываемого ПО, его технические характеристики, показатели качества и технико-экономические требования, предписание по выполнению необходимых стадий создания документации (конструкторской, технологической, программной и т. д.) и её состав, а также специальные требования [3]. На данной стадии участников проектных работ разделяют на потребителей (заказчиков этих работ) и поставщиков (исполнителей этих работ, подрядчиков). Исполнителя-специалиста называют проектировщиком или разработчиком. Поставщиком, как и потребителем продукции, может быть организация (юридическое лицо) или конкретный человек (физическое лицо). Стадия Техническое задание состоит из, следующих этапов:

1. Обоснование необходимости разработки программы - на этом этапе выполняются:

· Постановка задачи.

· Сбор исходных материалов.

· Выбор и обоснование критериев эффективности и качества разрабатываемой программы.

· Обоснование необходимости проведения научно-исследовательских работ.

2. Научно-исследовательские работы - на этом этапе выполняются:

· Определение структуры входных и выходных данных.

· Предварительный выбор методов решения задачи.

· Обоснование целесообразности применения ранее разработанных программ.

· Определение требований к техническим средствам.

· Обоснование принципиальной возможности решения поставленной задачи.

3. Разработка и утверждение технического задания - на этом этапе выполняются:

· Определение требований к программе.

· Разработка технико-экономического обоснования разработки программы.

· Определение стадий, этапов и сроков разработки программы и документации на неё.

· Выбор языков программирования.

· Определение необходимости проведения научно-исследовательских работ на последующих стадиях.

Стадия Эскизный проект. Эскизный проект разрабатывают, если это предусмотрено техническим заданием или протоколом рассмотрения технического предложения. Эскизный проект разрабатывают с целью установления принципиальных (конструктивных, схемных и др.) решений ПО, дающих общее представление о принципе работы и (или) устройстве ПО, когда это целесообразно сделать до разработки технического проекта или рабочей документации [7]. При разработке эскизного проекта выполняют работы, необходимые для обеспечения предъявляемых к ПО требований и позволяющие установить принципиальные решения. Перечень необходимых работ определяется разработчиком в зависимости от характера и назначения ПО и согласовывается с заказчиком, если ПО разрабатывается по заказам Министерства обороны. Стадия Эскизный проект состоит из, следующих этапов:

1. Разработка эскизного проекта - на этом этапе выполняются:

· Предварительная разработка структуры входных и выходных данных.

· Уточнение методов решения задачи.

· Разработка общего описания алгоритма решения задачи.

· Разработка технико-экономического обоснования.

2. Утверждение эскизного проекта - на этом этапе выполняются:

· Разработка пояснительной записки.

· Согласование и утверждение эскизного проекта.

Стадия Технический проект. Технический проект разрабатывают, если это предусмотрено техническим заданием, протоколом рассмотрения технического предложения или эскизного проекта. Технический проект разрабатывают с целью выявления окончательных технических решений, дающих полное представление о ПО, когда это целесообразно сделать до разработки рабочей документации [7]. Стадия Технический проект состоит из, следующих этапов:

1. Разработка технического проекта - на этом этапе выполняются:

· Уточнение структуры входных и выходных данных.

· Разработка алгоритма решения задачи.

· Определение формы представления входных и выходных данных.

· Определение семантики и синтаксиса языка.

· Разработка структуры программы.

· Окончательное определение конфигурации технических средств.

2. Утверждение технического проекта - на этом этапе выполняются:

· Разработка плана мероприятий по разработке и внедрению программы.

· Разработка пояснительной записки.

· Согласование и утверждение технического проекта.

Стадия Рабочий проект. На данной стадии разработки происходит непосредственные программирование и отладка программы, производится испытание программы [5]. Производится корректировка программной документации по результатам испытаний. Стадия Рабочий проект состоит из, следующих этапов.

1. Разработка программы - на этом этапе выполняется:

· Программирование и отладка программы.

2. Разработка программной документации - на этом этапе выполняется:

· Разработка программных документов в соответствии с требованиями ЕСПД.

3. Испытания программы - на этом этапе выполняются:

· Разработка, согласование и утверждение программы и методики испытаний.

· Проведение предварительных государственных, межведомственных, приемо-сдаточных и других видов испытаний.

· Корректировка программы и программной документации по результатам испытаний.

Стадия Внедрение. На данной стадии разработки происходит внедрение ПО в те условия, где оно будет эксплуатироваться [5]. Производится окончательная подготовка программной документации. Происходит процедура оформление и утверждение акта о передаче программы. Стадия Внедрение состоит из единственного этапа:

1. Подготовка и передача программы - на этом этапе выполняются:

· Подготовка и передача программы и программной документации для сопровождения и /или изготовления.

· Оформление и утверждение акта о передаче программы на сопровождение и/или изготовление.

· Передача программы в фонд алгоритмов и программ.

Таким образом, мы рассмотрели из каких стадий состоит оформление документации. Описали какая стадия, что из себя представляет и из каких этапов каждая из них состоит. Рассмотрели, что происходит на каждом этапе разработки.

3. Правила оформления программной документации

Программная документация является неотъемлемым компонентом программного продукта и должна оформляться в соответствии с Единой системой программной документации (ЕСПД - ГОСТ серии 19). В рамках учебных работ допускается заключать всю содержательную часть программной документации в единый «отчёт по программе», при этом формальные требования к оформлению такого отчёта соответствуют требованиям к отчёту по НИР. Программная документация, кроме формальных документов (спецификация, ведомость держателей подлинников, формуляр и др.), включает:

· Техническое задание (назначение, область применения программы, требования, предъявляемые к программе).

· Текст программы (запись программы с необходимыми комментариями).

· Описание программы (сведения о логической структуре и функционировании программы).

· Пояснительная записка (схема алгоритма, общее описание алгоритма и/или функционирования программы, обоснование принятых решений).

· Эксплуатационные документы.

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

К эксплуатационным документам относят:

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

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

· Руководство программиста (сведения для эксплуатации программы).

· Руководство оператора (сведения для обеспечения общения оператора с вычислительной системой в процессе выполнения программы).

· Описание языка (описание синтаксиса и семантики языка).

· Руководство по техническому обслуживанию (сведения для применения тестовых и диагностических программ при обслуживании технических средств).

Основная часть программной документации составляется на стадии рабочего проекта. Необходимость того или иного документа определяется на этапе составления технического задания. Допускается объединять отдельные виды документов. Эксплуатационный документ «Описание языка» включается в программную документацию, если разработанный программный продукт реализует некий язык программирования, управления заданиями, организации вычислительного процесса и т. П. Эксплуатационный документ «Руководство по техническому обслуживанию» включается в программную документацию, если разработанный программный продукт требует использования тестовых или диагностических программ.

Текст программы представляет собой символическую запись на исходном или промежуточном языке или символическое представление машинных кодов. Текст программы оформляется моноширинным шрифтом (Courier, Lucida Console и т. П.) в соответствии с общепринятыми нормами оформления [6]:

1. Количество операторов на строчке должно быть равно 1.

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

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

4. Если синтаксис языка позволяет, желательно отделять знаки операций пробелами от операндов. Как и в обычном тексте, после запятых должен следовать пробел.

5. Определения функций или логические части программы следует отделять друг от друга пустыми строками.

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

7. Текст программы должен содержать комментарии, отражающие функциональное назначение того или иного блока программы, структуру программы.

Документ Описание программы содержит:

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

· Функциональное назначение (классы решаемых задач, сведения о функциональных ограничениях на применение);

· Описание логической структуры (алгоритм программы, используемые методы, структура программы с описанием составных частей и связи между ними);

· Используемые технические средства (типы ЭВМ и устройств, которые используются при работе программы);

· Вызов и загрузка (способ вызова программы с соответствующего носителя данных);

· Входные данные (характер, организация и предварительная подготовка входных данных, а также их формат, описание и способ кодирования);

· Выходные данные (характер и организация выходных данных, а также их формат, описание и способ кодирования).

Описание логической структуры программы следует сопровождать блок-схемой программы. Документ «Описание программы» может содержать также схемы данных, схемы взаимодействия программ, схемы ресурсов системы и проч., оформленные в соответствии с ГОСТ 19.701-90 [6].

Документ Описание применения относится к эксплуатационным документам и состоит из следующих разделов:

· Назначение программы (возможности, основные характеристики, ограничения области применения).

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

· Описание задачи (указываются определения задачи и методы её решения).

· Входные и выходные данные.

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

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

· Структура программы (сведения о структуре, взаимосвязи между модулями программы и с другими программами).

* Настройка программы (настройка на состав технических средств, выбор функций)/

* Проверка программы (способы и методики проверки, контрольные примеры, методы прогона, результаты).

* Дополнительные возможности.

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

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

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

* Характеристики программы (временные характеристики, режимы работы, средства контроля правильности выполнения и т. П.).

* Обращение к программе (способы передачи управления и параметров данных).

* Входные и выходные данные (формат и кодирование).

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

Документ Руководство оператора относится к эксплуатационным документам и состоит из следующих разделов:

* Назначение программы (информация, достаточная для понимания функций программы и её эксплуатации);

* Условия выполнения программы (минимальный и/или максимальный набор технических и программных средств и т. П.);

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

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

При оформлении текстовых и графических материалов, входящих в программную документацию следует придерживаться действующих стандартов. Некоторые положения этих стандартов приведены ниже. Оформление текстового и графического материала. Текстовые документы оформляют на листах формата А4, причем графический материал допускается представлять на листах формата A3. Поля на листе определяют в соответствии с общими требованиями: левое - не менее 30, правое - не менее 10, верхнее - не менее 15, а нижнее - не менее 20 мм [1]. В текстовых редакторах для оформления записки параметры страницы заказывают в зависимости от устройства печати. При ручном оформлении документов параметры страницы выбирают из соображений удобства. Нумерация всех страниц - сквозная. Номер проставляется сверху справа арабской цифрой. Страницами считают, как листы с текстами и рисунками, так и листы приложений. Первой страницей считается титульный лист. Номер страницы на титульном листе не проставляют. Наименование разделов пишут прописными буквами в середине строки. Расстояние между заголовками и текстом, а также между заголовками раздела и подразделов должно быть равно:

* При выполнении документа машинописным способом - двум интервалам.

* При выполнении рукописным способом - 10 мм.

* При использовании текстовых редакторов - определяется возможностями редактора.

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

* При выполнении документа машинописным способом - трем интервалам.

* При выполнении рукописным способом - не менее 15 мм.

* При использовании текстовых редакторов - определяется возможностями редактора.

Разделы и подразделы нумеруются арабскими цифрами с точкой. Разделы должны иметь порядковые номера 1, 2, и т. Д. Номер подраздела включает номер раздела и порядковый номер подраздела, входящего в данный раздел, разделенные точкой. Например: 2.1, 3.5. Ссылки на пункты, разделы и подразделы указывают, используя порядковый номер раздела или пункта, например, «в разд. 4», «в п. 3.3.4». Текст разделов печатают через 1,5-2 интервала. При использовании текстовых редакторов высота букв и цифр должна быть не менее 1,8 мм (шрифты № 11-12). Перечисления следует нумеровать арабскими цифрами со скобкой, например: 2), 3) и т. Д. - с абзацного отступа. Допускается выделять перечисление простановкой дефиса перед пунктом текста или символом, его заменяющим, в текстовых редакторах. Оформление рисунков, схем алгоритмов, таблиц и формул. В соответствии с ГОСТ 2.105-79 «Общие требования к текстовым документам» иллюстрации (графики, схемы, диаграммы) могут быть приведены как в основном тексте, так и в приложении. Все иллюстрации именуют рисунками. Все рисунки, таблицы и формулы нумеруют арабскими цифрами последовательно (сквозная нумерация) или в пределах раздела (относительная нумерация). В приложении - в пределах приложения. Каждый рисунок должен иметь подрисуночную подпись - название, помещаемую под рисунком, например: Рис.12. Форма окна основного меню.

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

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

Схемы алгоритмов должны быть выполнены в соответствии со стандартом ЕСПД. Толщина сплошной линии при вычерчивании схем алгоритмов должна составлять от 0,6… 1,5 мм. Надписи на схемах должны быть выполнены чертежным шрифтом, высота букв и цифр должна быть не менее 3,5 мм.

Номер таблицы размещают в правом верхнем углу или перед заголовком таблицы, если он есть. Заголовок, кроме первой буквы, выполняют строчными буквами. Ссылки на таблицы в тексте пояснительной записки указывают в виде слова «табл.» и номера таблицы. Например: Результаты тестов приведены в табл. 4.

Номер формулы ставится с правой стороны страницы в круглых скобках на уровне формулы. Например: z:=sin(x)+ln(y); (12)

Ссылка на номер формулы дается в скобках. Например: «расчет значений проводится по формуле (12)».

Оформление приложений. Каждое приложение должно начинаться с новой страницы с указанием в правом углу слова «ПРИЛОЖЕНИЕ» пропис-ными буквами и иметь тематический заголовок. При наличии более одного приложения все они нумеруются арабскими цифрами: ПРИЛОЖЕНИЕ 1, ПРИЛОЖЕНИЕ 2 и т. Д. Например: ПРИЛОЖЕНИЕ 2 Титульный лист расчетно-пояснительной записки.

Рисунки и таблицы, помещаемые в приложении, нумеруют арабскими цифрами в пределах каждого приложения с добавлением буквы «П», Напри-мер: Рис. П. 12 - 12-й рисунок приложения; Рис. П1.2 - 2-й рисунок 1-го приложения.

Если в приложении приводится текст программы, то каждый файл оформляют как рисунок с наименованием файла и его назначением, например: Рис. П2.4. Файл menuran.pas - программа движения курсора основного меню.

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

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

При ссылке на источник из списка литературы (особенно при обзоре аналогов) надо указывать порядковый номер по списку литературы, заклю-ченный в квадратные скобки; например: [5].

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

4. Нормативные документы и госты

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

* ИПК "Издательство стандартов", Территориальный отдел распространения НТД (магазин "Стандарты"), 17961, Москва, ул. Донская, д. 8, тел. 236-50-34, 237-00-02, факс/тел. 236-34-48 (в части ГОСТ и ГОСТ Р) [9].

* ВНИИКИ Госстандарта России (читальный зал), 103001, Москва, Гранатный пер. д. 4, тел. 290-50-94 (в части международных, зарубежных стандартов и других НТД) [5] [9].

И никаких цитат и вторичных источников. ГОСТ - это закон. Не верьте никому, кроме оригинала. Тем не менее, далее автору придется прибегать к цитированию ЕСПД (Единая система программной документации), снимая при этом с себя всяческую ответственность.

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

* Основополагающие и организационно-методические стандарты.

* Стандарты, определяющие формы и содержание программных документов, применяемых при обработке данных.

* Стандарты, обеспечивающие автоматизацию разработки программных документов.

В перечень документов ЕСПД входят, следующие госты [9]:

* ГОСТ 19.001-77 ЕСПД. Общие положения.

* ГОСТ 19.101-77 ЕСПД. Виды программ и программных документов (переиздан в ноябре 1987г с изм.).

* ГОСТ 19.102-77 ЕСПД. Стадии разработки.

* ГОСТ 19.103-77 ЕСПД. Обозначение программ и программных документов.

* ГОСТ 19.104-78 ЕСПД. Основные надписи.

* ГОСТ 19.105-78 ЕСПД. Общие требования к программным документам.

* ГОСТ 19.106-78 ЕСПД. Требования к программным документам, выполненным печатным способом.

* ГОСТ 19.201-78 ЕСПД. Техническое задание. Требования к содержанию и оформлению.

* ГОСТ 19.202-78 ЕСПД. Спецификация. Требования к содержанию и оформлению.

* ГОСТ 19.301-79 ЕСПД. Программа и методика испытаний.

* ГОСТ 19.401-78 ЕСПД. Текст программы. Требования к содержанию и оформлению.

* ГОСТ 19.402-78 ЕСПД. Описание программы.

* ГОСТ 19.404-79 ЕСПД. Пояснительная записка. Требования к содержанию и оформлению.

* ГОСТ 19.501-78 ЕСПД. Формуляр. Требования к содержанию и оформлению.

* ГОСТ 19.502-78 ЕСПД. Описание применения. Требования к содержанию и оформлению.

* ГОСТ 19.503-79 ЕСПД. Руководство системного программиста. Требования к содержанию и оформлению.

* ГОСТ 19.504-79 ЕСПД. Руководство программиста.

* ГОСТ 19.505-79 ЕСПД. Руководство оператора.

* ГОСТ 19.506-79 ЕСПД. Описание языка.

* ГОСТ 19.508-79 ЕСПД. Руководство по техническому обслуживанию. Требования к содержанию и оформлению.

* ГОСТ 19.604-78 ЕСПД. Правила внесения изменений в программные документы, выполняемые печатным способом.

* ГОСТ 19.701-90 ЕСПД. Схемы алгоритмов, программ, данных и систем. Условные обозначения и правила выполнения.

* ГОСТ 19.781-90. Обеспечение систем обработки информации программное.

Дабы избежать не верного написания программной документации, нужно руководствоваться всеми вышеперечисленными нормативными документами. Многие из этих документов были разработаны в 70-е и 80-е годы. Частично эти стандартны морально устарели, к тому же они не лишены некоторых недостатков. Во-первых, в них не отражены некоторые современные тенденции оформления программ и программной документации, во-вторых, в этих стандартах наличествует многократное дублирование фрагментов программной документации. Тем не менее, за неимением лучшего вам придётся ориентироваться именно на них.

Таким образом, нами рассмотрены нормативные документы и ГОСТы, которыми необходимо пользоваться при написании документации. Приведён подробный перечень этих ГОСТов.

Заключение

Мы рассмотрели на какие категории деляют документацию. Ознакомились с документами, которые входят в Эксплутационную документацию и в документацию согласно ЕСПД.

Мы рассмотрели из каких стадий состоит оформление документации. Описали какая стадия, что из себя представляет и из каких этапов каждая из них состоит. Рассмотрели, что происходит на каждом этапе разработки.

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

Нами рассмотрены нормативные документы и ГОСТы, которыми необходимо пользоваться при написании документации. Приведён подробный перечень этих ГОСТов.

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

Список использованных источников

1. Госстандарт СССР. Единая система программной документации. Требования к программным документам, выполненным печатным способом. Переиздание (Ноябрь 1987 г.) с Изменением № 1, утвержденным в июле 1981 г Государственным комитетом стандартов Совета Министров СССР (ИУС 7-81).

2. Госстандарт СССР. Единая система программной документации.Обозначение программ и программных документов. Переиздание (Ноябрь 1987 г.) с Изменением № 1, утвержденным в июле 1981 г Государственным комитетом стандартов Совета Министров СССР (ИУС 7-81).

3. Госстандарт СССР. Единая система программной документации.Техническое задание требования к содержанию и оформлению. Переиздание (Ноябрь 1987 г.) с Изменением № 1, утвержденным в июле 1981 г Государственным комитетом стандартов Совета Министров СССР (ИУС 7-81).

4. Разработка документации по ГОСТ [Электронный ресурс] : [web-сайт] / Режим доступа: http://www.rugost.com - 21.09.14.

5. Учебный центр «Interface» [Электронный ресурс] : [web-сайт] / Режим доступа: http://www.interface.ru/ - 20.09.14.

6. Южный технологический центр «Ориентир» [Электронный ресурс] : [web-сайт] / Разработка ЮТЦ «Ориентир», 2009 - Режим доступа: http://orientir-yug.ru/ - 27.09.14.

7. Кафедра информационно-измерительных систем и физической электроники [Электронный ресурс] : [web-сайт] / Режим доступа: http://dfe.petrsu.ru/index.php - 02.10.14.

8. Википедия - общедоступная мультиязычная универсальная интернет-энциклопедия [Электронный ресурс] : [web-сайт] / Режим доступа: https://ru.wikipedia.org - 02.10.14.

9. Карпов В.Э. [Электронный ресурс] : Об оформлении программной документации - Режим доступа: http://www.raai.org/about/persons/karpov/pages/ofdoc/ofdoc.html - 02.10.14.

Размещено на Allbest.ru