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

Виды эксплуатационной документации и требования к ней

1.1. Все имеющиеся на предприятии подлинники, дубликаты и копии программных документов, кроме документа «Техническое задание», подлежат учету и хранению в специальных бюро (группах) в отделе технической документации (ОТД) или бюро технической документации (БТД), организуемых на предприятии в соответствии с требованиями ГОСТ 2.501-88.

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

https://www.youtube.com/watch?v=ytcreators

1.3. В случае утери или порчи программного документа в ОТД или БТД составляют соответствующий акт о списании по форме, соответствующей требованиям ГОСТ 2.501-88.В графе «Наименование», кроме наименования программного документа, должен быть указан вид носителя данных, на котором выполнен программный документ, с указанием количества носителя данных.

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

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

Говоря о состоянии ЕСПД в целом, можно констатировать, что большая часть стандартов  морально устарела.

  • ориентацию на единственную, «каскадную» модель жизненного цикла программы;
  • отсутствие четких рекомендаций по документированию характеристик качества;
  • отсутствие связей с  другими действующими отечественными системами стандартов,  например ЕСКД;
  • плохо выраженный подход к документированию программы,  как товарной продукции;
  • отсутствие рекомендаций по внутреннему документированию, как например экранные меню, справка по работе с программой итд.;
  • отсутствие рекомендаций по составу, содержанию и оформлению документов на программу, согласованных с  международными и региональными стандартами.

Из этого выходит, что ЕСПД нуждается в полном пересмотре на основе стандарта ИСО/МЭК 12207-95, (об этом стандарте далее будет расказанно более подробнее).

Стоит заметить что, кроме ЕСПД  в официальной нормативной базе РФ в области документирования программ и в смежных областях есть  ряд перспективных стандартов, например:

  • международный стандарт ISO/IEC 12207: 1995-08-01 на организацию жизненного цикла продуктов программного обеспечения.
  • Стандарты комплекса ГОСТ 34 на создание и развитие автоматизированных систем.
  • стандарты ЕСПД вносят характерный порядок в процесс документирования программ;
  • предусмотренный стандартами ЕСПД состав программных документов  возможно видоизменять  внося в комплект документации  дополнительные виды документов.
  • стандарты ЕСПД позволяют  изменять структуру и содержание исходя из конкретных требований заказчика и пользователя.

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

Kод группы Наименование группы
Общие положения
1 Основополагающие стандарты
2 Правила выполнения документации разработки
3 Правила выполнения документации изготовления
4 Правила выполнения документации сопровождения
5 Правила выполнения эксплуатационной документации
6 Правила обращения программной документации
7 Резервные группы
8
9 Прочие стандарты
  • числа 19 (присвоенных классу стандартов ЕСПД);
  • одной цифры (после точки), обозначающей код классификационной группы стандартов, указанной таблице;
  • двузначного числа (после тире), указывающего год регистрации стандарта.

1.1. Внесение изменений в программные документы, выполненные печатным способом, производят по ГОСТ 19.603-78 и правилам, установленным настоящим стандартом.

1.1. Под изменением программного документа понимается любое внесение и (или) удаление каких-либо данных без изменения общей части обозначения документа. Обозначение документа допускается изменять только в случае ошибочного присвоения одинаковых обозначений разным документам или когда в обозначении документа допущена ошибка.(Измененная редакция, Изм. N 1).

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

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

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

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

1.6. Подлинники, дубликаты и копии извещений имеет право выпускать только предприятие — держатель подлинников, при этом копии извещений имеет право выпускать предприятие — держатель дубликата.

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

1.8. Предложения об изменении (ПР) на предприятии — держателе дубликатов и копий рекомендуется оформлять на бланках подлинников извещений и направлять их для дальнейшего оформления предприятию — держателю подлинника.

1.9. Не допускается вносить изменения в программные документы и проводить доработку программ на основании ПР.

ПОДРОБНЕЕ:  Правила увольнения по инициативе работника Советник

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

Разработка программной документации

  • что должно быть сделано, кроме программы?
  • какая документация должна быть написана?
  • что передавать пользователям, а что ? службе сопровождения?
  • как управлять процессом разработки?
  • что должно входить в техническое задание?

Кроме упомянутых вопросов есть и многие другие.

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

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

https://www.youtube.com/watch?v=ytadvertise

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

ПРИЛОЖЕНИЕ 2 (рекомендуемое). ПРИМЕР ЗАПОЛНЕНИЯ ИЗВЕЩЕНИЯ

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

2.2. Подлинники и дубликаты извещений должны быть выполнены на материале, с которого можно многократно снимать копии.

2.3. Извещения следует выполнять черной тушью шрифтом по ГОСТ 2.304-81 или печатным способом. Допускается выполнять извещения машинным способом.

2.4. Форма извещения и заполнения граф должна соответствовать требованиям ГОСТ 2.503-90. При этом в графе «Обозначение» должно быть проставлено обозначение документа по ГОСТ 19.103-77.Пример заполнения извещения приведен в приложении 2.

2.5. Извещение может иметь приложения. Приложения могут содержать части, предназначенные для осуществления указанных изменений, в том числе и с помощью ЭВМ. Эти части должны быть выполнены на согласованном с пользователем носителе данных и оформлены в соответствии с требованиями стандартов ЕСПД на правила оформления программных документов на конкретных носителях данных.

2.4, 2.5. (Измененная редакция, Изм. N 1).

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

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

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

8.1, 8.2. (Измененная редакция, Изм. N 1).

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

8.4. На одном экземпляре копии извещения на лицевой стороне на первом листе ставят штамп «Контрольный экземпляр».

8.5. На основании извещения в отделе технической документации (бюро технической документации) вносят все связанные с ними изменения учтенных документов в инвентарную книгу подлинников и карточки учета документов в соответствии с требованиями ГОСТ 19.601-78.

8.6. Учет и хранение бюллетеней должны производиться по правилам учета и хранения извещений.

8.7. Учет извещений и ПР в книгах регистрации проводят в соответствии с требованиями ГОСТ 2.503-90.

8.8. Для учета рассылки копий извещений подразделениям данного предприятия и другим предприятиям применяется лист учета, который составляют и заполняют в соответствии с требованиями ГОСТ 2.503-90.(Измененная редакция, Изм. N 1).

8.9. Опись извещений составляют и заполняют в соответствии с требованиями ГОСТ 2.503-90. Опись является сопроводительным документом к копии (или дубликатам) извещений.

ПРИЛОЖЕНИЕ 2Рекомендуемое

(Измененная редакция, Изм. N 1).Электронный текст документаподготовлен АО «Кодекс» и сверен по:официальное изданиеЕдиная система программнойдокументации: Сб. ГОСТов. — М.: Стандартинформ, 2010

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

6.2. Для учета рассылки копий извещений и копий документов, выполненных печатным способом, подразделениям данного предприятия применяется лист учета, который составляют и заполняют в соответствии с требованиями ГОСТ 2.503-90.

2. УЧЕТ И ХРАНЕНИЕ ПОДЛИННИКОВ

3.1. Вносить изменения в подлинники имеет право только предприятие — держатель подлинника на основании извещения.

3.2. Вносить изменения в дубликаты имеет право предприятие — держатель дубликата извещения.

3.3. При изменении подлинника и дубликата аннулированием с заменой документа подлиннику и дубликату присваивают новый инвентарный номер. Место простановки инвентарного номера на каждом конкретном носителе должно соответствовать требованиям стандартов ЕСПД на правила оформления программных документов на различных носителях данных.(Измененная редакция, Изм. N 1).

ПОДРОБНЕЕ:  Дарственная на дом: как оформить договор дарения между близкими родственниками, какие документы нужны

3.4. Об изменениях, вносимых в подлинники и дубликаты, должна быть запись, содержание и место расположения которой должно соответствовать требованиям стандартов ЕСПД. Место записи об изменениях должно соответствовать требованиям стандартов ЕСПД на правила оформления программных документов на конкретных носителях данных.

3.5. Аннулированные по извещению подлинники и дубликаты снимаются с учета.

4.1. Изменения в контрольные копии вносят только на основании копии извещения об изменении.

4.2. Предприятие — держатель подлинника или предприятие — держатель дубликата извещений должны высылать копии извещения держателя контрольных копий.

4.3. Изменения в контрольные копии вносят по правилам, установленным для подлинников.

4.4. После замены контрольная копия снимается с инвентарного учета в архиве предприятия.

5.1.Общие требования

5.1.1. Учтенная копия — копия, взятая на учет на предприятии — держателе подлинника или дубликата программного документа для внесения изменений. Внесение изменений в учтенные копии производится по извещениям.

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

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

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

5.1.5. Бюллетень выпускают на комплект программных документов или отдельные документы.

5.1.6. Изменение программного документа, вызывающее какие-либо изменения в других программных документах, должно сопровождаться одновременным выпуском бюллетеней о внесении соответствующих изменений во все взаимосвязанные документы.

5.1.7. В бюллетене приводятся способы внесения изменений в копии.

5.1.8. Об изменениях, вносимых в копии, делается запись по п.3.4 настоящего стандарта.

5.2. Оформление бюллетеня

5.2.1. Каждый бюллетень должен иметь титульный лист и обозначение (номер), включающее:код предприятия (организации), выпустившего данный бюллетень;порядковый регистрационный номер.

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

«Бюллетень распространяется на

наименование программы или ее частей и их обозначение

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

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

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

5.2.6. Бюллетени о внесении изменений в программные документы выпускают и передают предприятию-пользователю не реже одного раза в шесть месяцев.

5.3. Порядок доведения бюллетеней об изменениях до предприятий (организаций) — держателей копий изменяемых документов

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

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

2.1. Изменения в подлинники следует вносить следующими способами:зачеркиванием и (или) записью тушью (или другим нестирающимся средством) новых данных;заменой отдельных листов документа;аннулированием отдельных листов;введением дополнительных листов;аннулированием или аннулированием с заменой документа.(Измененная редакция, Изм. N 1).

2.2. После внесения изменения зачеркиванием буквы, цифры и знаки должны быть четкими, толщина линий, размер просветов и т.п. должны быть выполнены по правилам, предусмотренным ГОСТ 2.303-68 и ГОСТ 2.304-81.

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

https://www.youtube.com/watch?v=ytabout

2.4. Изменения в подлинники вносят черной тушью в соответствии с содержанием извещения.

2.5. Около каждого изменения наносят порядковый номер изменения в кружке диаметром 5-8 мм и от кружка проводят сплошную тонкую линию к изменяемому участку.При внесении изменений в документы, имеющие нумерацию строк, линии от кружков не проводят и каждую строку документа, в которую вносят изменение, отмечают номером в кружке.

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

ПОДРОБНЕЕ:  Проверка залога нотариальная палата Советник

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

2.8. Изменения на замененных или новых листах подлинника отмечают вертикальной чертой с левой стороны текста. При этом отмечают только последние изменения.

2.9. При добавлении нового листа ему присваивают номер предыдущего листа, ставят точку и после нее указывают текущий номер дополнительного листа, например: 18; 18.1; 18.2; 18.3 и т.д.

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

2.10. Строку изменения заполняют только на листах замененных и новых, при этом заполняют и лист регистрации изменений (форма 1).При замене всех листов подлинника заполняют только лист регистрации изменений.

Лист регистрации изменений

Форма 1

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

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

2.13. При аннулировании документа на листе утверждения и титульном (первом) листе подлинника должен быть проставлен штамп «Аннулирован, заменен …, извещ. N … от … 19… г.».Если аннулирование производится без замены, слово «заменен» в штампе зачеркивают.Аннулированные по извещению документы снимают с учета. (Измененная редакция, Изм. N 1).

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

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

3.3. Изменения в копиях, не позволяющих свободную замену листов, вводят способами, указанными для подлинников с учетом следующих особенностей:заменяемую страницу (часть страницы) аннулируют перечеркиванием с записью об аннулировании и номера извещения. К заменяемой странице (части страницы) подклеивают новую страницу (часть страницы);

при этом должна сохраняться возможность чтения записи, сделанной на заменяемой странице;дополнительную страницу приклеивают на страницу, продолжением которой она является.Допускается приклеивать дополнительную страницу в конце документа. В этом случае на странице, предшествующей дополнительной, делается надпись: «Далее см. стр….».

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

Номер страницы (листа), пункта, абзаца, строки

Содержание изменений

Способ внесения изменений

Имеется

Должно быть

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

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

4. ПРЕДЛОЖЕНИЕ ОБ ИЗМЕНЕНИИ (ПР)

4.1. Обозначение, оформление и выпуск ПР производят по ГОСТ 19.603-78.

6.1. Каждое ПР должно иметь обозначение извещения с добавлением букв «ПР».

6.2. Оформление и выпуск ПР производят в соответствии с требованиями ГОСТ 2.503-90.

ПРИЛОЖЕНИЕ 2 (рекомендуемое). ПРИМЕР ЗАПОЛНЕНИЯ ИЗВЕЩЕНИЯ

5.1. Порядок согласования извещений об изменении и ПР должны соответствовать требованиям ГОСТ 2.503-90.

7.1. Порядок согласования извещения об изменении и ПР должен соответствовать требованиям ГОСТ 2.503-90.

ПРИЛОЖЕНИЕ 1 (справочное). ИНФОРМАЦИОННЫЕ ДАННЫЕ О СООТВЕТСТВИИ ГОСТ 19.603-78 СТ СЭВ 2089-80

ПРИЛОЖЕНИЕ 1Справочное

Разд.1, 2, 3 ГОСТ 19.603-78 соответствуют разд.1, 2, 3 СТ СЭВ 2089-80.Разд.5 ГОСТ 19.603-78 соответствует разд.4 СТ СЭВ 2089-80.(Введено дополнительно, Изм. N 1).

https://www.youtube.com/watch?v=upload

ПРИЛОЖЕНИЕСправочное

Разд.2 ГОСТ 19.604-78 соответствует разд.2 СТ СЭВ 2089-80.(Введено дополнительно, Изм. N 1).Электронный текст документаподготовлен АО «Кодекс» и сверен по:официальное изданиеЕдиная система программнойдокументации: Сб. ГОСТов. — М.: Стандартинформ, 2010

Понравилась статья? Поделиться с друзьями:
Adblock
detector