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

Реферат

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

Проблемы определения потребности документирования программных средств, которые следует решать в проектах, начинаются с анализа, с целью понять каждую решаемую проблему до начала разработки проекта и комплекса документов программного средства: выявить заинтересованных лиц и пользователей документов, чье коллективное мнение в конечном итоге определяет успех или неудачу проекта и его документации;Оценки масштаба проекта ПС должны быть проанализированы и скорректированы для установления в договоре между заказчиками и разработчиками исходного компромиссного масштаба, допустимого для разработки первичных требований к комплексу документации. Некоторые требования могут потребовать изменения (обычно увеличения) масштаба, и соответственно ресурсов на этапах предварительного и детального проектирования для обеспечения возможности реализации требуемой функциональной пригодности. Стоимость ресурсов для их документирования напрямую зависит от масштаба ПС и не всегда целесообразно создавать и использовать весь комплекс шаблонов документов в реальных проектах. Каждый из разработчиков, так или иначе, должен участвовать в управлении требованиями как к проекту, так и к его документации. Разработчикам необходимо выработать профессиональные приемы для понимания и изложения в документах потребностей пользователей, управления масштабом проекта, построением системы и документации, удовлетворяющих достаточно полно эти потребности, которые включают: команда разработчиков ПС, получает представление о сложности и размере создаваемого продукта и составе его документации;Тем самым характеристики ПС не только декларируются в виде требований, но и сопровождаются совокупностью рекомендуемых мероприятий документов по их обеспечению и реализации. Основные требования к документации при проектировании детализируются по компонентам программной системы и этапам их создания. При первичной оценке ресурсов, необходимых для документирования проектов ПС наибольшее значение имеют три ключевых фактора: размер — масштаб, подлежащих разработке полностью новых программных компонентов и документов; размер и относительная доля готовых программных компонентов и документов, которые могут быть заимствованы из предшествовавших проектов и повторно использованы в новом проекте ПС; Оценивая масштаб, функции и требования к документации, заказчик и разработчики должны хотя бы приближенно представлять тот объем затрат и физический размер комплекса документации, который придется создать в процессе всего жизненного цикла ПС, а также для обеспечения его эффективного применения.

10 стр., 4520 слов

Перспективы развития управления проектами

... И организационных. Управление проектами должно занять особое место в комплексе мер, реализуемых сегодня в России в контексте государственных программ социально-экономического развития страны, включая новый этап реформ в экономике, ... более используют в своей повседневной деятельности методы и средства УП. Например, почти все официальные лица правительства США используют программное обеспечение UP на ...

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

  • проектирование и разработку;
  • выпуск документации;
  • сопровождение документации.

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

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

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

9 стр., 4083 слов

Жизненный цикл и процессы нефтегазового проекта на примере ОАО ...

... управлении проектами. Предмет изучения курсовой работы является предприятие ОАО «ЛУКОЙЛ». Целью курсовой работы является определение основных методологических подходов в управлении проектным циклом, чтобы показать, какие механизмы и компоненты используются в процессе управления проектным ...

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

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

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

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

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

4 стр., 1978 слов

Внедрение информационных систем. Основные проблемы и задачи

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

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

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

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

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

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

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

8 стр., 3736 слов

Поля в документе по госту

... документация требования к оформлению документов «Об информации, информационных технологиях и о защите информации» , от 22 октября 2004 г. Как оформить курсовую работу по ГОСТ 2021 Требования к оформлению курсовой работы по ГОСТ 2021 Правила оформления курсовой работы по ГОСТ Как ...

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

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

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

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

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

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

37 стр., 18257 слов

Система менеджмента качества на предприятии. Обоснование экономической ...

... 1. Система менеджмента качества на предприятии Недавно сертификат соответствия системы менеджмента качества требованиям ISO 9001 был добавлен к документам, ... документации С МК На этом этапе формируются нормативные документы, положения и процедуры, обеспечивающие функционирование системы менеджмента качества. Основой для них обычно является уже существующий на предприятии набор документов, ...

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

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

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

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

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

36 стр., 17965 слов

Документирование операций. Документирование хозяйственных операций ...

... документировании хозяйственных операций документы должны быть качественно составлены, содержать достоверные данные об объемах и сроках хозяйственных операций. Официальные лица, подписавшие документ, несут ответственность за достоверность данных. Документы ... 835 «О первичных учетных документах» возложило на Госкомстат Российской Федерации функции по разработке, утверждению и распространению альбомов ...