ГОССТАНДАРТ РОССИИ - Информационная технология ПРОЦЕСС СОЗДАНИЯ ДОКУМЕНТАЦИИ ПОЛЬЗОВАТЕЛЯ ПРОГРАММНОГО СРЕДСТВА
8.1.3.3 Контроль плана документирования
После официального согласования плана документатор должен нести ответственность за контроль и распространение данного плана. Документатором должен быть составлен список по распространению учтенных копий данного плана.
В случае внесения в план последующих изменений (согласованных документатором и заказчиком) документатор должен гарантировать получение этих изменений всеми держателями учтенных копий.
Примечание — Вследствие проблем, возникающих при наличии устарелых копий плана, документатор должен запретить его несанкционированное копирование и предусмотреть процедуры аудита всех обновляемых копий плана.
8.1.4 Проверка (анализ)
8.1.4.1 Общие положения
Соответствующие проверки должны проводиться заказчиком с привлечением документатора (при необходимости).
Примечание — Целью проверки является гарантирование полноты и правильности представленных материалов и удовлетворения ими потребностей заказчика в соответствии с условиями договора и планом документирования.
Проверка должна проводиться персоналом заказчика, обладающим соответствующей квалификацией и полномочиями по предложению изменений в документацию и утверждению измененной документации.
Примечание — Заказчик должен ограничить количество проверяющих лиц до пределов, необходимых для реализации функции проверки.
При утверждении (согласовании) каждого проекта документации заказчик должен гарантировать правильность решения вопросов ее защиты и законности.
Документация для проверки должна представляться с сопроводительным письмом от документатора, в котором должны быть указаны цели проверки и обязанности проверяющей стороны (эксперта).
Примечания
1 Качество документации и успешность проверок повышаются при наличии хороших контактов между заказчиком и документатором в процессе разработки документации. При этом должно быть предусмотрено неформальное обсуждение возникающих вопросов и по возможности раннее представление заказчику образцов документации или предварительных материалов.
2 Договор может быть скорректирован при необходимости внесения в него изменений, не связанных с областью действия договора или плана документирования.
3 Отметим, что проведение проверки не освобождает документаторов от обязанностей по гарантированию максимально возможной полноты и точности документации.
4 Непосредственно перед представлением любой публикации на утверждение, в ней должны быть обновлены все распечатки экранов для гарантирования ее актуальности.
5 Результаты проверок представляются заказчиком документатору в виде пометок в проекте документации или письменных комментариев по его содержанию. Заказчик должен хранить копии всех вносимых изменений для сравнения их с последующими проектами документации. Представляемые заказчиком комментарии должны быть в виде, позволяющем персоналу разработчиков документации внести предлагаемые изменения в проект документации без дальнейших пояснений.
6 Для больших сложных систем или систем, разрабатываемых одновременно с документацией, может быть необходимо более двух проектов документации и наличие гранок. В этом случае максимальное число проектов (редакций) документации должно быть оговорено между заказчиком и документатором и указано в плане документирования.
7 При проверке проектов документации используют редакционные разметки (знаки, цвета, разметка шрифтов и прочее), Целью редакционных разметок является выделение частей публикации, нуждающихся в уточнении. Тем самым предотвращается необходимость в повторных проверках проектов. Настоятельно рекомендуется для внесения редакционной разметки использовать средства автоматизированного сравнения документов (при их наличии).
При редакционной разметке рекомендуется:
a) не вносить разметку в распечатку первого проекта (редакции) новой публикации;
b) использовать разметку для показа изменений, вносимых в оригинал проверяемой публикации;
c) во втором проекте использовать разметки с номером 1 для указания изменений, внесенных по результатам проверки первой редакции;
d) в третьем проекте использовать разметки с номером 2 аналогично номеру 1;
e) после принятия третьего проекта все разметки в нем должны быть сохранены до проверки гранок публикации.
8.1.4.2 Проверка плана документирования
Данная проверка должна гарантировать, что документация, предусмотренная планом документирования, после его выполнения будет удовлетворять целям заказчика. При утверждении плана документирования заказчик согласовывает все характеристики номенклатуры поставки, предусмотренной планом.
Примечание — Заказчики должны уделять особое внимание структуре, полноте и практичности документации в соответствии с планом-проспектом ее содержания. План документирования должен быть проверен и утвержден (согласован) до начала работ над первым проектом документации. Рекомендации по оценке плана приведены в приложении G.
8.1.4.3 Проверка первой редакции
Первая редакция (проект) должна содержать основную часть документации в соответствии с планом документирования, а также содержание, приложения и словарь (словник, определения). При применении средств автоматического создания указателя каждая его предметная рубрика (индекс) должна ссылаться на конкретные пункты документации. Орфография, пунктуация, стиль и компоновка документации должны соответствовать указанным в плане документирования.
Первый проект документации должен быть проверен заказчиком. Данная проверка предназначена для контроля технической правильности и полноты документации и должна гарантировать соответствие данного проекта заданиям плана документирования. Также проверяют соответствие орфографии, пунктуации, стиля и компоновки документации требованиям плана документирования.
При утверждении первого проекта заказчик согласовывает техническую правильность, структуру, понятность и полноту документации, исключая предложенные изменения.
Примечания
1 Перед предъявлением заказчику первый проект должен быть отредактирован по следующим причинам:
a) чтобы проверяющий не отвлекался на корректировку типографских и компоновочных ошибок;
b) чтобы любые технические неточности, внесенные при редактировании, были обнаружены проверяющим.
2 Проект должен быть проверен на соответствие выданным заданиям, указанной аудитории, содержанию и другим характеристикам, согласованным в плане документирования. Перед возвратом первого проекта с комментариями документатору заказчик должен быть уверен, что проект, включая все корректировки, соответствует плану документирования.
8.1.4.4 Проверка второго проекта
Во второй проект документации должны быть включены все изменения, согласованные с заказчиком при проверке первого проекта, а комплектность поставки второго проекта по возможности должна соответствовать номенклатуре поставки, оговоренной в плане документирования.
Данная проверка предназначена для контроля правильности внесения в документацию всех изменений, указанных заказчиком на этапе первого проекта.
При утверждении второго проекта заказчик согласовывает все аспекты документации за исключением физической формы представления документации по данному проекту, которая может не соответствовать указанной в номенклатуре поставки.
Примечание — При утверждении второго проекта заказчик должен быть уверен, что по данному проекту (включая внесенные изменения по результатам проверки первого проекта) могут быть изготовлены гранки.
8.1.4.5 Проверка гранок
В подготовленные гранки документации должны быть внесены все изменения, указанные заказчиком при проверке второго проекта.
Данная проверка предназначена для контроля правильности внесения в документацию всех изменений, указанных заказчиком на этапе второго проекта. Любые обнаруженные заказчиком несоответствия должны быть немедленно доведены до сведения документатора, который должен соответствующим образом модифицировать документацию и представить копии измененных разделов заказчику для дальнейшей проверки.
Утверждая (согласовывая) гранки документации, заказчик подтверждает готовность конкретного документа к производству (тиражированию).
8.1.5 Тестирование документации на практичность
8.1.5.1 Общие положения
