5 ФУНКЦИИ ПРОГРАММНОЙ ДОКУМЕНТАЦИИ

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

Программную документацию можно рассматривать как имеющую шесть основных функций:

1) информация для управления (см. 5.1);

2) связь между задачами (см. 5.2);

3) обеспечение качества (см. 5.3);

4) инструкции и справки (см. 5.4);

5) сопровождение программного обеспечения (см. 5.5);

6) исторические справки (см. 5.6).

Читайте также

10.1 ВЗАИМОДЕЙСТВИЕ ДРАЙВЕРОВ С ПРОГРАММНОЙ И АППАРАТНОЙ СРЕДОЙ В системе UNIX имеется два типа устройств — устройства ввода/вывода блоками и устройства неструктурированного или посимвольного ввода-вывода. Как уже говорилось в главе 2, устройства ввода-вывода блоками,

Пример программной реализации трехмерной операции Рассмотрим выполнение трехмерной формообразующей операции вручную (то есть в самом КОМПАС) и с помощью воображаемого подключаемого модуля. В качестве примера выберем обычную операцию выдавливания на основе несложного

18.1. Концепции документации В первую очередь необходимо определить различия между WYSIWYG-программами (WYSIWYG, "What You See Is What You Get" — "что видишь, то и получаешь") и инструментами разметки (Markup-Centered Tools). Большинство настольных издательских программ и текстовых процессоров входят в

Соглашения по документации Основной текст книги представлен этим шрифтом.Тексты, набранные данным шрифтом, являются кодом, скриптами или примерами командной строки.! ! !ПРИМЕЧАНИЕ. Фрагменты текста, выделенные как этот, - используются для того, чтобы привлечь ваше

Оформление документации Концепция подготовки документации в ArchiCAD базируется на понятии Layout Book (Книга чертежей). Под этим термином понимается совокупность листов чертежа (Layout), на которых пользователь может размещать виды проекта. Лист чертежа связан с шаблоном (Master) –

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

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

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

Четыре мира программной разработки Из предшествующей дискуссии следует, что когда мы говорим об ОО-разработке, следует различать четыре отдельных мира:[x]. Моделируемую систему, - внешнюю по отношению к программной системе, описываемую типами объектов и их абстрактными

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

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

6.1. ПОНЯТИЕ АРХИТЕКТУРЫ ПРОГРАММНОЙ СИСТЕМЫ Разработка архитектуры системы — это процесс разбиения большой системы на более мелкие части. Для обозначения этих частей придумано множество названий: программы, компоненты, подсистемы…Процесс разработки архитектуры —