7.2.2 Документация продукции
7.2.2 Документация продукции
Документация продукции обеспечивает информацию, необходимую для эксплуатации, сопровождения, модернизации, преобразования и передачи программной продукции.
Документация продукции преследует три цели:
1) она обеспечивает учебную и справочную информацию для любого использующего или эксплуатирующего программную продукцию;
2) она облегчает программистам, не разрабатывавшим программное обеспечение, его сопровождение и модернизацию;
3) она помогает продаже или приемке программной продукции.
Документация продукции должна включать в себя материалы для следующих типов читателей:
пользователей, которые вводят данные, восстанавливают информацию и решают задачи с помощью программного обеспечения;
операторов, которые «прогоняют» программное обеспечение на вычислительной системе;
сопровождающих программистов, которые сопровождают, модернизируют или изменяют программное обеспечение.
Документация продукции может также включать в себя:
руководства и материалы для руководителей, которые следят за использованием программного обеспечения;
вспомогательные материалы, освещающие возможности программной продукции и уточняющие ее функции, условия эксплуатации и т. д.;
общую информацию, описывающую программную продукцию для всех заинтересованных лиц.
Типовые документы продукции включают в себя:
учебные руководства;
справочные руководства и руководства пользователя;
руководства по сопровождению программного обеспечения;
брошюры и информационные листовки, посвященные продукции.
7.2.3 Документация управления проектом
Документы создают на основе информации управления проектом, такой как:
графики для каждой стадии процесса разработки и отчеты об изменениях графиков;
отчеты о согласованных изменениях программного обеспечения;
отчеты о решениях, связанных с разработкой;
распределение обязанностей.
Данная документация обеспечивает информацию, относящуюся, с точки зрения руководства, к долговечности продукции.
Более 800 000 книг и аудиокниг! 📚
Получи 2 месяца Литрес Подписки в подарок и наслаждайся неограниченным чтением
ПОЛУЧИТЬ ПОДАРОКЧитайте также
Документация
Документация Вы когда-нибудь использовали сторонние библиотеки? Фирма-разработчик обычно присылает красивое руководство с десятками глянцевых иллюстраций с кружочками и стрелочками; на обратной стороне каждой иллюстрации приводится абзац текста с описанием
7.3.7. Документация и CMM
7.3.7. Документация и CMM Ключевые практики описывают несколько документов, связанных с процессом, каждый из которых охватывает определенные области содержания. Ключевые практики не требуют соответствия «один к одному» между этими документами и реальными промежуточными
Глава 24 Учет товаров, продукции, услуг
Глава 24 Учет товаров, продукции, услуг В этой главе рассматриваются документы, оформляемые при учете материально-производственных запасов, продукции, товаров и услуг. Вы познакомитесь с тем, как на основании документов о поступлении и реализации товарно-материальных
Урок № 67. Передача собственных материалов в переработку на сторону и передача продукции из давальческого сырья
Урок № 67. Передача собственных материалов в переработку на сторону и передача продукции из давальческого сырья В процессе производственной деятельности предприятия часто приходится осуществлять передачу собственных материалов стороннему переработчику для выпуска
7.6. Документация
7.6. Документация Наследие разработки Разработка программной системы включает в себя гораздо больше, чем просто написание кода. Некоторые аспекты проекта должны быть постоянно доступны менеджерам разработки и внешним пользователям. Мы хотим также сохранить сведения о
1.5.1. Интерактивная документация
1.5.1. Интерактивная документация В дистрибутивы Linux входят man-страницы с описанием большинства стандартных команд, системных вызовов и стандартных библиотечных функций. Интерактивная документация разбита на разделы, которым присвоены номера. Для программистов наиболее
3.2 Документация пользователя
3.2 Документация пользователя 3.2.1 Полнота (completeness) Документация пользователя должна содержать информацию, необходимую для использования продукта. В документации пользователя должны быть полностью описаны все функции, установленные в описании продукта, и все вызываемые
4.2.2 Документация пользователя
4.2.2 Документация пользователя Должно быть протестировано выполнение соответствующих требований раздела 3, а выполнение рекомендаций раздела 3 может быть
Документация
Документация Разработчики классов и систем должны обеспечивать руководство, заказчиков и других разработчиков ясными высокоуровневыми описаниями создаваемого ПО. Им необходим инструментарий, помогающий в этой работе. Большая часть документации должна автоматически
12 Документация
12 Документация В этой главе рассказывается, как хороший архив документов помогает системному администратору лучше работать и эффективнее управлять своим временем.Но вначале поговорим о том, почему мы не любим, боимся и вообще избегаем составлять документацию.Мы с