Документирование программного обеспечения Средства для проектирования и визуализации – Draw.io
Цели лекции: 1. Понять значение и роль документации в процессе разработки программного обеспечения. 2. Ознакомиться с основными видами документации. 3. Изучить основные подходы и инструменты для создания документации. ________________________________________ 1. Введение в документирование ПО • Зачем нужна документация? o Поддержка пользователей. o Упрощение поддержки и сопровождения. o Улучшение совместной работы в команде. o Ускорение процесса передачи знаний и адаптации новых участников команды. • Кто создает документацию? o Разработчики, технические писатели, менеджеры проектов, QA-инженеры. 2. Основные виды документации • Пользовательская документация o Руководства пользователя, инструкции, FAQ. o Помогает конечным пользователям понять, как использовать ПО. • Разработческая документация o Описание архитектуры, модули, классы, интерфейсы, API. o Полезна для разработчиков и тех, кто будет поддерживать продукт. • Техническая документация o Включает технические спецификации, схемы архитектуры, базы данных. o Ориентирована на администраторов, системных инженеров. • Проектная документация o Описание целей, требований, этапов разработки и сроков. o Полезна для менеджеров проектов и заказчиков. 3. Методология и подходы к документированию • Waterfall и документация o Традиционный подход с обширной документацией на каждом этапе. • Agile и документация o Гибкий подход: минимизация документации, но создание необходимых для работы документов. • Lean и документация o Документирование только действительно нужных аспектов. 4. Инструменты для документирования • Средства управления версиями – Git, GitHub для хранения документации. • Системы управления документацией – Confluence, SharePoint. • Автоматические генераторы документации – Javadoc, Sphinx, Doxygen. • Средства для проектирования и визуализации – Draw.io, Lucidchart. 5. Основные принципы качественной документации • Простота и ясность – избегайте сложных терминов и избыточной информации. • Актуальность – регулярное обновление документов по мере изменений. • Консистентность – одинаковое форматирование, структура. • Доступность – легкость в навигации и поиске нужной информации. 6. Практическое задание • Задание: Разработать краткую техническую документацию для небольшого приложения, включающую описание архитектуры, список основных функций и требования к окружению.
