Документирование ПС

2/21/2001

Содержание

Цели документирования
Виды документации
Документация пользователя
Документы по сопровождению

2/21/2001

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

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

2/21/2001

Важность документирования

Хорошая документация регулирует процесс разработки ПС
Иерархия документов необходима для инспекций
Точная

2/21/2001

Требования к документации

Аккуратность
Точность
Содержательность
Полнота
Простота

2/21/2001

Виды документации

Документы управления разработкой ПС (software process documentation) управляют и протоколируют

2/21/2001

Документы управления разработкой

Планы, оценки, расписания
Отчеты об использовании ресурсов в процессе разработки
Стандарты

2/21/2001

Документы в составе ПС

Пользовательская документация ПС (П-документация)
Документация по сопровождению ПС

2/21/2001

Применение пользовательской документации

При инсталляции ПС
При применении ПС (решении задач)
При управлении ПС

2/21/2001

Категории пользователей

Обычные пользователи и администраторы
Отличаются по образованию, специализации, знанию предметной области

2/21/2001

Содержание пользовательской документации

Пользовательская документация должна отвечать на следующие вопросы:
Что может делать

2/21/2001

Разновидности пользовательских документов

Общее функциональное описание ПС - дает краткую характеристику функциональных

2/21/2001

Документация по сопровождению

Документация, определяющая строение программ и структур данных ПС и

2/21/2001

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

Внешнее описание ПС (Requirements document).
Описание архитектуры ПС
Для каждой