Движение за открытую проектную документацию — направление в проектировании программного обеспечения, приоритетами которого являются подробное документирование всех стадий создания компьютерных программ и общедоступность полученной документации. Об организации этого движения было объявлено в 2002 г. на торжественном открытии полуфинальных соревнований командного студенческого чемпионата мира по программированию профессором СПбГУ ИТМО А. А. Шалыто. Апробация разработки проектной документации в рамках этого движения производилась при выполнении проектов, создаваемых с помощью Switch-технологии, предназначенной для поддержки автоматного программирования.
Мотивация[]
Участники движения пропагандируют подробное документирование программных проектов, потому что в этом случае:
- повышается качество программного проекта;
- упрощается верификация программы;
- модификация проекта становится легче и безопаснее.
Документация по мнению участников движения должна быть открытой, потому что при этом:
- судьба проекта в меньшей степени зависит от его первоначальных авторов;
- понимание проекта упрощается;
- повторное использование проектных решений упрощается;
- становится возможным применять проекты для обучения и передачи знаний.
Применимость[]
Это движение находится в иной плоскости по сравнению с движением за свободное программное обеспечение и движением за открытые исходные коды. Принцип открытой проектной документации может в той или иной модификации применяться и к коммерческим (и даже секретным) проектам.
Основные принципы[]
- Код должен основываться на проектной документации, а не наоборот.
- Документация должна описывать не только конечный продукт, но и процесс его создания.
- Документация должна быть понятна программистам более низкого профессионального уровня, чем ее автор.
- Документация должна быть доступна при изучении и модификации структуры программы.
Ссылки[]
- Движение за открытую проектную документацию на сайте кафедры «Технологии программирования» СПбГУ ИТМО
- Проекты, созданные в поддержку движения на сайте кафедры «Технологии программирования» СПбГУ ИТМО
- Движение за открытую проектную документацию на сайте проекта Code Project
- w: en: OScar (open source car) (OpenSource автомобиль)