732.12K

Category:

software

Документирование программного обеспечения

1.

Санкт-Петербургский государственный университет телекоммуникаций
им. проф. М.А. Бонч-Бруевича
ПРОГРАММНОЕ ОБЕСПЕЧЕНИЕ ЦЕНТРОВ
ОБРАБОТКИ ДАННЫХ
Лекция 5. Документирование программного обеспечения
Выборнова Анастасия Игоревна, к.т.н., доцент кафедры ССиПД

2. Документирование ПО

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

3. Документирование ПО

Тестирование программного обеспечения – это один
из этапов его разработки.
Определение
требований
Проектирование
Разработка
Тестирование
Сопровождение
Поставка
Документация

4. Документирование ПО

Кто пишет документацию?
• Системный аналитик – техническое задание и другие
документы, фиксирующие требования к ПО.
• Тестировщик или QA-аналитик – документация,
связанная с тестированием (тест-план, test cases и др).
• Технический писатель – техническое задание,
руководства пользователя, администратора, другая
пользовательская документация.
• Product manager – пользовательские материалы.
• Копирайтер – пользовательские материалы.

5. Документирование ПО

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

6. Внутренняя документация

Внутренняя документация создается всеми членами
команды и призвана облегчить коммуникацию и
передачу опыта, сделать процесс разработки ПО более
понятным и прозрачным.
• Use cases и другие аналитические документы,
создаваемые в процессе проектирования ПО.
• Тест-план, test cases.
• Руководства по развертыванию приложений (deploy).
• Внутренняя база знаний.
• Описание принятых в компании процессов разработки
и др.

7. Внешняя документация

Внешняя документация создается обычно аналитикам и
техническими писателями с целью облегчения
коммуникации с заказчиком/пользователем на всех
стадиях разработки ПО.
• Техническое задание.
• Протокол приемо-сдаточных испытаний (ПСИ).
• Руководство администратора, руководство
пользователя.
• И др.

8. Документирование ПО

Как еще можно классифицировать документацию?
• Проектная
• Техническая
• Пользовательская
• Маркетинговая

9. Документация по ГОСТ

При создании документации «по ГОСТ» важно выбрать
правильный ГОСТ. При создании программных
продуктов чаще всего речь будет идти об одном из
следующих «зонтичных» стандартов:
• ГОСТ 19 – Единая система программной
документации (ЕСПД).
• ГОСТ 34 – Автоматизированные системы.