7.2.1. Документация разработки
7.2.1. Документация разработки
Документы, описывающие процесс разработки программного обеспечения, определяют требования, которым должно удовлетворять программное обеспечение, определяют проект программного обеспечения, определяют, как его контролируют и как обеспечивают его качество. Документация разработки, также включает в себя подробное техническое описание программного обеспечения (программную логику, программные взаимосвязи, форматы и хранение данных и т. д.).
Разработка документов преследует пять целей;
1) они являются средством связи между всеми вовлеченными в процесс разработки. Они описывают подробности решений, принятых относительно требований к программному обеспечению, проекту, программированию и тестированию;
2) они описывают обязанности группы разработки. Они определяют, кто, что и когда делает, учитывая роль программного обеспечения, предмета работ, документации, персонала, обеспечивающего качество, и каждого вовлеченного в процесс разработки;
3) они выступают как контрольные пункты, которые позволяют руководителям оценивать ход разработки. Если документы разработки отсутствуют, неполны или устарели, руководители теряют важное средство для отслеживания и контроля проекта программного обеспечения;
4) они образуют основу документации сопровождения программного обеспечения, требуемой сопровождающими программистами как часть документации продукции;
5) они описывают историю разработки программного обеспечения.
Типовыми документами разработки являются:
анализы осуществимости и исходные заявки;
спецификации требований;
спецификации функций;
проектные спецификации, включая спецификации программ и данных;
планы разработки;
планы сборки и тестирования программного обеспечения;
планы обеспечения качества, стандарты и графики;
защитная и тестовая информация.
Более 800 000 книг и аудиокниг! 📚
Получи 2 месяца Литрес Подписки в подарок и наслаждайся неограниченным чтением
ПОЛУЧИТЬ ПОДАРОКЧитайте также
3.3. Прочая документация
3.3. Прочая документация Каталог /usr/share/doc представляет собой всеохватывающее место для несобранной иными способами документации. Большинство пакетов, установленных в вашей системе, инсталлируют внутри каталога /usr/share/doc файлы "README", документацию в разных форматах (включая
Документация
Документация Вы когда-нибудь использовали сторонние библиотеки? Фирма-разработчик обычно присылает красивое руководство с десятками глянцевых иллюстраций с кружочками и стрелочками; на обратной стороне каждой иллюстрации приводится абзац текста с описанием
14.1.5. Документация по безопасности
14.1.5. Документация по безопасности Многие считают документацию уделом бюрократов и категорически не пишут никаких инструкций или других руководств. Я сам до поры до времени был таким и предпочитал следить за системой самостоятельно, пока она не стала слишком сложной, что
7.3.7. Документация и CMM
7.3.7. Документация и CMM Ключевые практики описывают несколько документов, связанных с процессом, каждый из которых охватывает определенные области содержания. Ключевые практики не требуют соответствия «один к одному» между этими документами и реальными промежуточными
Проектная документация
Проектная документация У каждого проекта в Google есть основной проектный документ. Это живой документ, он развивается вместе с проектом. Вначале этот документ описывает цель проекта, предпосылки его создания, предполагаемый список участников и архитектурных решений. На
7.6. Документация
7.6. Документация Наследие разработки Разработка программной системы включает в себя гораздо больше, чем просто написание кода. Некоторые аспекты проекта должны быть постоянно доступны менеджерам разработки и внешним пользователям. Мы хотим также сохранить сведения о
1.2.2. Комментарии и встроенная документация
1.2.2. Комментарии и встроенная документация Комментарии в Ruby начинаются со знака решетки (#), находящегося вне строки или символьной константы, и продолжаются до конца строки:x = y + 5 # Это комментарий.# Это тоже комментарий.print "# А это не комментарий."Предполагается, что
1.5.1. Интерактивная документация
1.5.1. Интерактивная документация В дистрибутивы Linux входят man-страницы с описанием большинства стандартных команд, системных вызовов и стандартных библиотечных функций. Интерактивная документация разбита на разделы, которым присвоены номера. Для программистов наиболее
3.2 Документация пользователя
3.2 Документация пользователя 3.2.1 Полнота (completeness) Документация пользователя должна содержать информацию, необходимую для использования продукта. В документации пользователя должны быть полностью описаны все функции, установленные в описании продукта, и все вызываемые
4.2.2 Документация пользователя
4.2.2 Документация пользователя Должно быть протестировано выполнение соответствующих требований раздела 3, а выполнение рекомендаций раздела 3 может быть
7.2.2 Документация продукции
7.2.2 Документация продукции Документация продукции обеспечивает информацию, необходимую для эксплуатации, сопровождения, модернизации, преобразования и передачи программной продукции.Документация продукции преследует три цели:1) она обеспечивает учебную и справочную
Документация
Документация Разработчики классов и систем должны обеспечивать руководство, заказчиков и других разработчиков ясными высокоуровневыми описаниями создаваемого ПО. Им необходим инструментарий, помогающий в этой работе. Большая часть документации должна автоматически
12 Документация
12 Документация В этой главе рассказывается, как хороший архив документов помогает системному администратору лучше работать и эффективнее управлять своим временем.Но вначале поговорим о том, почему мы не любим, боимся и вообще избегаем составлять документацию.Мы с