Якунин Ю.Ю. Технологии разработки программного обеспечения



Технологии разработки программного обеспечения. Учеб. пособие -191-

6

.

Д

О

К

У

М

Е

Н

Т

И

Р

О

В

А

Н

И

Е

П

Р

О

Г

Р

А

М

Н

Ы

Х

С

И

С

Т

Е

М

В

С

О

Т

В

Е

Т

С

Т

В

И

С

Г

О

С

Т

6

.

1

.

У

п

р

а

в

л

е

н

и

е

д

о

к

у

м

е

н

т

и

р

о

в

а

н

и

е

м

п

р

о

г

р

а

м

н

о

г

о

б

е

с

п

е

ч

е

н

и

я

Управление документированием программного обеспечения должно

выполняться в соответствии с ГОСТ Р ИСО/МЭК ТО 9294–93. Данный ГОСТ

разработан техническим комитетом по стандартизации ТК 22 «Информаци-

онная технология». Утвержден и введен в действие постановлением Госстан-

дарта России от 20.12.93 № 260. Стандарт подготовлен на основе применения

аутентичного текста технических рекомендаций ИСО/МЭК ТО 9294–90

«Информационная технология. Руководство по управлению документирова-

нием программного обеспечения».

6

.

1

.

1

.

О

б

л

а

с

т

ь

п

р

и

м

е

н

е

н

и

я

Данный стандарт п

редставляет собой руководство по документирова-

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

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

ководство предназначено для помощи руководи

телям в обеспечении эффек-

тивного проведения документирования в их организациях.

Данный стандарт направлен на определение стратегий, стандартов,

процедур, ресурсов и планов, которыми должны заниматься сами руководи-

тели для того, чтобы эффективно управлять документированием программ-

ного обеспечения.

Руководство предназначено для применения ко всем типам программ-

ного обеспечения – от простейших программ до наиболее сложного про-

граммного набора или системы программного обеспеч

ения. Охвачены все

типы программной документации, относящиеся ко всем стадиям жизненного

цикла программного обеспечения.

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

одинаковы для любого объема проекта. Для небольших проектов значитель-

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

нять, но принципы остаются теми же. Руководители могут адаптировать дан-

ные реко

мендации для своих конкретных потребностей.

Следует подчеркнуть, что руководство дано с точки зрения управления

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

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

6. ДОКУМЕНТИРОВАНИЕ ПРОГРАММНЫХ СИСТЕМ В СООТВЕТСТВИИ С ГОСТ

6.1. Управление документированием программного обеспечения



Технологии разработки программного обеспечения. Учеб. пособие -192-

6

.

1

.

2

.

Р

о

л

ь

р

у

к

о

в

о

д

и

т

е

л

е

й

Руководители принимают на себя организацию работ по документиро-

ванию и осуществляют поддержку этих работ в стратегиях, стандартах, про-

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

Эффективность выполнения руководя

щей роли можно рассматривать

как основанную на трех элементах:

1) руководящая обязанность по документированию. Данная обязан-

ность требует признания того, что программная;

2) документация важна и что ее следует планировать, описывать, про-

верять, утверждать, выпускать, распространять и сопровождать;

3) руководящая поддержка обязанностей персонала по документирова-

нию.

Для этого требуется руководство и стимулирование персонала при

проведении требуемого документирования и обесп

ечение его ресурсами для

содействия в данной работе.

Для этого требуется обеспечить:

а) опубликованные официальные отчеты о стратегии документирова-

ния;

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

вания программного обеспечения;

в) опубликованные процедуры документирования;

г) выделение соответствующих ресурсов для документирования;

д) планирование документир

ования, осуществляемое как неотъемлемая

часть процесса разработки программного обеспечения;

е) постоянную проверку, осуществляемую для обеспечения соответст-

вия со стратегией, стандартами, процедурами и планами по документирова-

нию.

6

.

1

.

3

.

Ф

у

н

к

ц

и

п

р

о

г

р

а

м

н

о

й

д

о

к

у

м

е

н

т

а

ц

и

Для эффективного управления док

ументированием программного

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

тацией.

Программную документацию можно рассматривать ка

к имеющую

шесть основных функций:

информация для управления;

связь между задачами;

обеспечение качества;

инструкции и справки;

сопровождение программного обеспечения;

исторические справки.

6. ДОКУМЕНТИРОВАНИЕ ПРОГРАММНЫХ СИСТЕМ В СООТВЕТСТВИИ С ГОСТ

6.1. Управление документированием программного обеспечения



Технологии разработки программного обеспечения. Учеб. пособие -193-

6

.

1

.

3

.

1

.

И

н

ф

о

р

м

а

ц

и

я

д

л

я

у

п

р

а

в

л

е

н

и

я

Во время разработки программного обеспечения администрации необ-

ходимо оценивать ход работы, возникающие проблемы и вероятности разви-

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

по графику и представля

ют планы на следующий период, обеспечивают кон-

трольные механизмы и обзор проекта.

6

.

1

.

3

.

2

.

С

в

я

з

ь

м

е

ж

д

у

з

а

д

а

ч

а

м

и

Большинство проектов разработки программного обеспеч

ения разделя-

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

В типовом варианте:

специалисты в предметной области начинают проект;

аналитик

и формулируют требования к системе;

проектировщики разрабатывают системный и программный проекты;

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

соответствии со стратегией и стандартами по документированию;

специалисты по обеспечению качества и ревизоры оценивают общую

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

сопровождающие программисты улучшают эксплуатируемое про-

граммное обеспечение и разрабатывают его изменения или расширения.

Этим людям необходимы средства общения друг с другом, обеспечи-

вающие информацию, которую можно, при необходимости, воспроизводить,

распространять и на которую можно ссылаться.

Большинство метод

ологий разработки программного обеспечения ус-

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

аналитики представляют официальные спецификации требований для проек-

тировщиков, а проектировщики выдают официальные проектные специфи-

кации для программистов.

6

.

1

.

3

.

3

.

О

б

е

с

п

е

ч

е

н

и

е

к

а

ч

е

с

т

в

а

Требуется документация разработки и документация продукции для

выполнения зад

ач, связанных с обязанностями по обеспечению качества про-

граммного обеспечения.

6

.

1

.

3

.

4

.

И

н

с

т

р

у

к

ц

и

с

п

р

а

в

к

и

Документация, требующая

ся операторам, пользователям, руководите-

лям и другим заинтересованным лицам для того, чтобы понимать и исполь-

зовать программную продукцию.

6. ДОКУМЕНТИРОВАНИЕ ПРОГРАММНЫХ СИСТЕМ В СООТВЕТСТВИИ С ГОСТ

6.1. Управление документированием программного обеспечения



Технологии разработки программного обеспечения. Учеб. пособие -194-

6

.

1

.

3

.

5

.

С

о

п

р

о

в

о

ж

д

е

н

и

е

п

р

о

г

р

а

м

н

о

г

о

б

е

с

п

е

ч

е

н

и

я

Сопровождающим программистам требуется детальное о

писание про-

граммного обеспечения, такое, чтобы они могли локализовать и корректиро-

вать ошибки и модернизировать или изменять программное обеспечение со-

ответствующим образом.

6

.

1

.

3

.

6

.

И

с

т

о

р

и

ч

е

с

к

и

е

с

п

р

а

в

к

и

Документация, требуемая в кач

естве исторической справки по проекту.

Данная документация может помочь в переносе и переводе программного

обеспечения в новое окружение.

6

.

1

.

4

.

У

с

т

а

н

о

в

л

е

н

и

е

с

т

р

а

т

е

г

и

д

о

к

у

м

е

н

т

и

р

о

в

а

н

и

я

Стратеги

и документирования, подготовленные и отслеживаемые глав-

ной администрацией, обесп

ечивают руководства для ответственных лиц,

принимающих решения на всех нижних уровнях. Стратегия обеспечивает

главное направление, но не дает рекомендаций, что делать или как это де-

лать.

Из-за существенной роли, которую играет документация на всех стади-

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

официально утвержденная ст

ратегия. Каждый затронутый стратегией должен

быть информирован о ней и должен ее понимать. Официальная, описанная,

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

эффективного документирования программного обеспечения.

Стратегия должна поддерживать основные элементы эффективного до-

кументирования:

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

граммного обеспечения.

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

доступна и сопровождаться на всем протяжении процесса разработки про-

граммного обеспеч

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

ция необходима для использования, сопровождения, модернизации, преобра-

зования или передачи программного обеспечения.

2. Документирование должно быть управляемым.

Управление и контроль требуются для получения и сопровождения до-

кументации. Руководители и специалисты по изданиям должны подготовить

подробные планы, охватывающие документир

ование продукции, графиков,

обязанностей, ресурсов, обеспечения качества и процедур проверок;

3. Документация должна соответствовать ее читательской аудитории.

Читателями могут быть руководители, аналитики, специалисты по экс-

пертным системам, сопровождающие программисты, канцелярский персонал

и т. д. В зависимости от выполняемых задач им требуются различные степе-

ни детализации и различное представление мат

ериала. Специалисты по изда-

6. ДОКУМЕНТИРОВАНИЕ ПРОГРАММНЫХ СИСТЕМ В СООТВЕТСТВИИ С ГОСТ

6.1. Управление документированием программного обеспечения



Технологии разработки программного обеспечения. Учеб. пособие -195-

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

личные типы документации, предназначенные для различных читателей.

4. Работы по документированию должны быть объединены в общий

процесс разработки программного обеспечения.

Процесс разработки должен быть определен.

5. Должны быть определены и использованы стандарты по документи-

рованию.

По возможности, должны быть приняты существующие стандарты. Ко-

гда подходящие ст

андарты отсутствуют, должны быть разработаны требуе-

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

6. Должны быть определены средства поддержки.

Должны быть использованы там, где это экономически целесообразно,

средства, помогающие разработке и сопровождению программной продук-

ции, включая документацию.

6

.

1

.

5

.

О

п

р

е

д

е

л

е

н

и

е

с

т

а

н

д

а

р

т

о

в

и

р

у

к

о

в

о

д

с

т

в

п

о

д

о

к

у

м

е

н

т

и

р

о

в

а

н

и

ю

Внутри организаций должны быть приняты стан

дарты и руководства:

для модели жизненного цикла программного обеспечения;

типов и взаимосвязей документов;

содержания документа;

качества документа;

форматов документа;

обозначения документа.

Данные стандарты и руководства будут определять, как следует вы-

полнять задачи документирования, и будут обеспечиват

ь критерии для оцен-

ки полноты, полезности и соответствия программной документации, созда-

ваемой в организации.

По возможности должны быть приняты действующие международные

и национальные стандарты. Если подходящие стандарты отсутствуют, то ор-

ганизация должна разработать собственные.

Большинство стандартов и руководств выдают рекомендации, которые

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

решения для ад

аптации общих рекомендаций к конкретным проектам. При-

менение стандартов, распространяющихся на организацию документирова-

ния, облегчит руководителям проекта определение следующих вопросов:

Какие типы документов требуются?

Каков объем представляемой документации?

Что документы содержат?

Какой уровень качества будет достигнут?

Где документы будут созданы?

Как документы будут хранить, сопровождать и обращать?

Если возможен ко

нтракт на программное обеспечение, контракт дол-

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

6. ДОКУМЕНТИРОВАНИЕ ПРОГРАММНЫХ СИСТЕМ В СООТВЕТСТВИИ С ГОСТ

6.1. Управление документированием программного обеспечения



Технологии разработки программного обеспечения. Учеб. пособие -196-

должен определять типы составляемых документов, уровень качества каждо-

го и процедуры их проверки и утверждения.

6

.

1

.

5

.

1

.

В

ы

б

о

р

м

о

д

е

л

и

ж

и

з

н

е

н

о

г

о

ц

и

к

л

а

п

р

о

г

р

а

м

н

о

г

о

б

е

с

п

е

ч

е

н

и

я

Существу

ет ряд моделей жизненного цикла программного обеспечения

с отличающейся терминологией для различных стадий. С точки зрения про-

граммной документации, не имеет значения, какая модель выбрана, до тех

пор, пока стадии и соответствующая им документация четко определены,

спланированы и выпол

няемы для любого конкретного программного проек-

та. Поэтому руководители должны выбрать соответствующую модель жиз-

ненного цикла программного обеспечения и гарантировать, чтобы ее приме-

няли в данной организации.

Руководители должны убедиться, что выбранные стадии и соответст-

вующие задачи помогут им в контроле за ходом любого программного про-

екта. Создание документации, связанной с кон

кретной стадией, может, на-

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

завершения стадии до начала следующей.

6

.

1

.

5

.

2

.

О

п

р

е

д

е

л

е

н

и

е

т

и

п

о

в

и

с

о

д

е

р

ж

а

н

и

я

д

о

к

у

м

е

н

т

о

в

Ниже дана схема ос

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

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

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

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

своих документов.

Программные документы можно представить разделенными на три ка-

тегории:

1) документация разработки;

2) документация продукции;

3) документация управления проектом.

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

щие процесс

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

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

обеспечения, определяют, как его контролируют и как обеспечивают его

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

описание программного обеспечения (программную логику, «программные»

взаимосвязи, форматы и хранение данных и т. д.).

Документы, описывающие пр

оцесс разработки:

1) являются средством связи между всеми вовлеченными в процесс

разработки. Описывают подробности решений, принятых относительно тре-

бований к программному обеспечению, проекту, программированию

и тестированию;

6. ДОКУМЕНТИРОВАНИЕ ПРОГРАММНЫХ СИСТЕМ В СООТВЕТСТВИИ С ГОСТ

6.1. Управление документированием программного обеспечения



Технологии разработки программного обеспечения. Учеб. пособие -197-

2) описывают обязанности группы разработки. Определяют, кто, что

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

документации, персонала, обеспечивающего качество, и каждого вовлечен-

ного в процесс разработки;

3) выступают как контрольные пункты, которые позволяют руководи-

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

неполны или устарели, руководители теряют важное средство для отслежи-

вания и контроля проекта программного обеспечения;

4) образуют основу документации сопровождения программного обес-

печения, требуемой сопровождающими програ

ммистами как часть докумен-

тации продукции;

5) описывают историю разработки программного обеспечения.

Типовыми документами разработки являются:

1) анализы осуществимости и исходные заявки;

2) спецификации требований;

3) спецификации функций;

4) проектные спецификации, включая спецификации программ и данных;

5) планы разработки;

6) планы сборки и тестирования программного обеспеч

ения;

7) планы обеспечения качества, стандарты и графики;

8) защитная и тестовая информация.

Документация продукции. Документация продукции обеспечивает

информацию, необходимую для эксплуатации, сопровождения, модерниза-

ции, преобразования и передачи программной продукции.

Документация продукции преследует три цели:

обеспечить учебную и справочную информацию для любого исполь-

зующего или эк

сплуатирующего программную продукцию;

облегчить программистам, не разрабатывавшим программное обеспе-

чение, его сопровождение и модернизацию;

помочь продаже или приемке программной продукции.

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

дующих типов читателей:

пользователей, которые вводят данные, восстанавливают информацию

и решают задачи с помощью программного обеспечения;

операторов, которые «прогоняют» программное обеспечение на вычис-

лительной сист

еме;

сопровождающих программистов, которые сопровождают, модернизи-

руют или изменяют программное обеспечение.

Документация продукции может также включать:

руководства и материалы для руководителей, которые следят за ис-

пользованием программного обеспечения;

вспомогательные материалы, освещающие возможности программной

продукции и уточняющие ее функции, условия эксплуатации и т. д.;

6. ДОКУМЕНТИРОВАНИЕ ПРОГРАММНЫХ СИСТЕМ В СООТВЕТСТВИИ С ГОСТ

6.1. Управление документированием программного обеспечения



Технологии разработки программного обеспечения. Учеб. пособие -198-

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

заинтересованных лиц.

Типовые документы продукции включают:

учебные руководства;

справочные руководства и руководства пользователя;

руководства по сопровождению программного обеспечения;

брошюры и информационные листовки, посвященные продукции.

Документация управления проектом. Документы создают на основе

информации управления проектом, такой как:

графики для каждой стадии процесса разработки и отчеты об измене-

ниях графиков;

отчеты о согласов

анных изменениях программного обеспечения;

отчеты о решениях, связанных с разработкой;

распределение обязанностей.

Данная документация обеспечивает информацию, относящуюся, с точ-

ки зрения руководства, к долговечности продукции.

6

.

1

.

5

.

3

.

О

п

р

е

д

е

л

е

н

и

е

к

а

ч

е

с

т

в

а

д

о

к

у

м

е

н

т

о

в

Руководители должны выбирать ст

андарты, распространяющиеся на

уровень качества, соответственно различным типам документов и различным

типам проектов и должны определять, как это кач

ество будет достигнуто и

поддержано.

Понятия качества, применимые к содержанию, структуре и представ-

лению документации:

качество содержания можно измерять в элементах точности, полноты и

ясности;

качество структуры можно измерять легкостью, с которой читатель

имеет возможность определить местоположение информации;

качество представления должно соответствовать типу проекта. Напри-

мер, руководство пользоват

еля может иметь форму набора машинописных

страниц, скрепленных вместе, или может быть типографской книгой с об-

ширными иллюстрациями, созданной специалистом по графике.

6

.

1

.

5

.

4

.

О

п

р

е

д

е

л

е

н

и

е

ф

о

р

м

а

т

о

в

д

о

к

у

м

е

н

т

о

в

Стандарт

изованные форматы документов важны для контроля качества

документов, для читаемости документов и для облегчения их сопровожде-

ния.

Информация может быть представлена в различных форматах. Проект-

ные спецификации, например, могут быть записаны на установленных блан-

ках. Обучение пользователя можно осущест

вить посредством учебных про-

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

6. ДОКУМЕНТИРОВАНИЕ ПРОГРАММНЫХ СИСТЕМ В СООТВЕТСТВИИ С ГОСТ

6.1. Управление документированием программного обеспечения



Технологии разработки программного обеспечения. Учеб. пособие -199-

Форматы документов могут различаться от проекта к проекту. Они за-

висят от таких факторов, как объем проекта, аудитория,, для которой предна-

значены документы, количество установленных стадий и бюджет докумен-

тирования.

В проектируемых форматах должны быть учтены соображения о том,

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

Стандарты и руководства данной организации, распространяю

щиеся на

форматы документов, должны быть установлены таким образом, чтобы до-

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

проектов.

6

.

1

.

5

.

5

.

О

п

р

е

д

е

л

е

н

и

е

с

и

с

т

е

м

ы

о

б

о

з

н

а

ч

е

н

и

я

д

о

к

у

м

е

н

т

о

в

Стандарт

ные обозначения документов необходимы для эффективного

контроля документации. Обозначающая информация может включать:

заглавие документа;

ссылочный номер документа;

номер версии документа;

дату выпуска и пересмотра;

реквизиты автора;

реквизиты утвердившего лица;

обозначение защищенности (авторских прав);

обозначение организации.

Если документы выпускают в виде разрозненных листов, каждая стра-

ница должна иметь индивидуальное обозначение (например, со ссылочным

номером документа, номером страницы и номер

ом издания).

6

.

1

.

6

.

У

с

т

а

н

о

в

л

е

н

и

е

п

р

о

ц

е

д

у

р

ы

д

о

к

у

м

е

н

т

и

р

о

в

а

н

и

я

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

ях страт

егий документирования.

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

планирование;

подготовка;

конфигурационное управление;

проверка;

утверждение;

производство;

хранение; дублирование;

распространение и модернизация; продажа.

Процедуры также должны определять контрольные пункты и методы

обеспечения качества.

6. ДОКУМЕНТИРОВАНИЕ ПРОГРАММНЫХ СИСТЕМ В СООТВЕТСТВИИ С ГОСТ

6.1. Управление документированием программного обеспечения



Технологии разработки программного обеспечения. Учеб. пособие -200-

6

.

1

.

7

.

Р

а

с

п

р

е

д

е

л

е

н

и

е

р

е

с

у

р

с

о

в

д

л

я

д

о

к

у

м

е

н

т

и

р

о

в

а

н

и

я

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

следующие:

персонал;

средств

а;

финансирование.

6

.

1

.

7

.

1

.

П

е

р

с

о

н

а

л

Для процесса разработки программного обеспеч

ения необходимы люди

со знанием:

программирования – для разработки программного обеспечения;

сути предмета – для представления информации о применениях про-

граммного обеспечения;

документирования – для разработки документации продукции. Важно,

чтобы штат был по

лностью обучен методам документирования и чтобы каж-

дая группа полностью понимала и выполняла свою роль в документирова-

нии.

Кроме того, нужны:

проектировщики программного обеспечения и программисты, которые

создают документацию разработки, описывающую продукцию или ее задачи;

они также обеспечивают документацию сопровождения программной про-

дукции;

специалисты в предметной области, обеспечивающие информацию для

(и могут разрабаты

вать) части стадий изучения, спецификаций требований,

планов тестирования и обеспечения качества, планов сборки программного

обеспечения в условиях эксплуатации и многих типов графиков;

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

цию по обучению пользователя, а также справочную, информационную до-

кументацию о продукции и посредническую.

6

.

1

.

7

.

2

.

С

р

е

д

с

т

в

а

Важно пр

едусмотреть обеспечение задач документирования соответст-

вующими и подходящими средствами.

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

контроля документации. Они могут быть применены для повышения эффек-

тивности многих процессов документирования и использования стандартов

данной организации, распрост

раняющихся на документирование.

6

.

1

.

7

.

3

.

Ф

и

н

а

н

с

и

р

о

в

а

н

и

е

Якунин Ю.Ю. Технологии разработки программного обеспечения

Подождите немного. Документ загружается.