- Документация объясняет, как устроена программа, как её проверить, настроить и использовать.
- Для разработчиков:
- Техническое задание – что необходимо разработать и каким требованиям должна соответствовать программа.
- Спецификация – из каких частей состоит программный продукт и какие документы к нему прилагаются.
- Описание программы – как устроена программа и по какому принципу она работает.
- Пояснительная записка – описание алгоритмов и обоснование принятых решений.
- Программа и методика испытаний – что, как и в какой последовательности нужно проверить.
- Для пользователей и специалистов:
- Руководство пользователя – как пользоваться программой.
- Руководство администратора – как установить, настроить и поддерживать программу.
- Руководство оператора – как выполнять основные операции в системе.
- Руководство по техническому обслуживанию – как проверять систему, находить ошибки и устранять неисправности.
- Doxygen – инструмент, который автоматически создаёт документацию для программ на C++ по комментариям в коде.
Информатика • 10 класс
1137
Документирование программ и читаемость кода (C++)
Было полезно?
Рекомендуем
Вы учитель или ученик?
Познакомьтесь с нашим образовательным онлайн-сервисом с тысячами интерактивных работ
Учителю
Удобно проводить уроки в классе, назначать работы на дом и анализировать результаты всего класса или конкретных учеников
Ученику
Самостоятельно изучать новые и повторять пройденные темы, готовиться по индивидуальной траектории и оценивать результаты на наглядных графиках