Презентация к проекту " Документирование программного обеспечения".

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

Цели документирования.

Классификация и назначение документации на ПС.

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

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

• Документация   является органической, составной частью программного продукта для ЭВМ и требуются значительные ресурсы для ее создания и применения.

• Тексты и объектный код программ для ЭВМ  могут стать программным продуктом  только в совокупности с комплексом документов, полностью соответствующих их содержанию и достаточных для его освоения, применения и изменения.

• Для этого документы должны быть корректными, строго адекватными текстам программ и содержанию баз данных – систематически, структурировано и понятно изложены, для возможности их успешного освоения и использования достаточно квалифицированными специалистами различных рангов и назначения.

ЦЕЛИ ДОКУМЕНТИРОВАНИЯ

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

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

Классы документов

Эту документацию можно разбить на  две группы: =

• документы управления разработкой ПС   (программного средства) - то есть документы, которые предназначены прежде всего для самих разработчиков и их начальства,

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

Документация проекта

• Описание проекта
• Планы
• Задания исполнителям  (задание распределённое между конкретными людьми или группами, участвующими в реализации проекта)
• отчёт о ходе работ - создаются менеджерами для контролирующих органов
• Протоколы встреч и обсуждений
• Отчёты о результатах активности
• Журналы

Документации продукта

• Технические требования
• Технические спецификации
• Сведения о выпуске (Release notes)
• Руководства  (напр - по эксплуатации и настройки)

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

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

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

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

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

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

• Ошибки и дефекты документов не менее опасны для применения ПС , чем ошибки в структуре, интерфейсах, файлах текстов программ и в содержании данных.

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

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

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

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

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

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

• Совокупные затраты на документирование крупных программных продуктов могут достигать 20 – 30% от общей трудоемкости проекта и необходимого числа (десятки) специалистов в жизненном цикле проекта ПС.

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

• Состав и общий объем документов широко варьируется в зависимости от класса и характеристик объекта раз­работки, а также в зависимости от используемой технологии.

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

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

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

документацию ПС можно разделить на :

• технологическую документацию процессов разработки и обеспечения всего жизненного цикла, включаю­щую подробные технические описания, и подготавливаемую для спе­циалистов, ведущих проектирование, разработку и сопровождение комплексов программ, обеспечивающую возможность отчуждения, детального освоения, развития и корректировки ими программ и данных на всем жизненном цикле ПС;

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

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

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

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

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

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

• При подготов­ке этих планов целесообразно по возможности разделять их цели и функции.

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

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

разработчик - изготовитель - пользователь документации .  Для этого объект по­требления, программный продукт, его документация и все процессы взаимодейст­вия в цепочке должны быть связаны системой экономических и тех­нических характеристик, в той или иной степени, использующих основные экономические показатели -  реальные затраты ресурсов: финансов, труда и времени специалистов на конечный программный продукт и документы. " width="640"

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

• Одна из важнейших задач документирования состоит в том , чтобы увязать четкими эконо­мическими категориями взаимодействие разных специалистов в типовой производственной цепочке: заказчик - разработчик - изготовитель - пользователь документации . 

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

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

• Сложность документирования, количество и полнота содержания комплекса документов в первую очередь зависят от  масштаба – размера проекта ПС , что целесообразно оценивать в начале его ЖЦ.

• Для решения этой задачи необходимо детально учитывать требуемые ресурсы современных процессов создания, документирования и использования программ различных классов и назначения  встроенных, коммерческих, административных, учебных, уникальных.

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

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