Облако знаний. Документирование программ и читаемость кода (Python). Информатика. 10 класс

Документирование программ и читаемость кода (Python)

Документация объясняет, как устроена программа, как её проверить, настроить и использовать.
Для разработчиков:
- техническое задание – что необходимо разработать и каким требованиям должна соответствовать программа;
- спецификация – из каких частей состоит программный продукт и какие документы к нему прилагаются;
- описание программы – как устроена программа и по какому принципу она работает;
- пояснительная записка – описание алгоритмов и обоснование принятых решений;
- программа и методика испытаний – что, как и в какой последовательности нужно проверить.
Для пользователей и специалистов:
- руководство пользователя – как пользоваться программой;
- руководство администратора – как установить, настроить и поддерживать программу;
- руководство оператора – как выполнять основные операции в системе;
- руководство по техническому обслуживанию – как проверять систему, находить ошибки и устранять неисправности.
Sphinx – инструмент, который помогает автоматически создавать документацию для программ на Python по комментариям и строкам документации в коде.

Было полезно?