Фонд открытой проектной документации - Foundation for Open Project Documentation

В Фонд открытой проектной документации [1]это организация. Его основная идея - создание подробной и общедоступной документации для всех этапов создания программного обеспечения. Фонд был основан в 2002 году на открытии полуфинала Международные соревнования по программированию ACM в Санкт-Петербург к Анатолий Шалыто. Об этом фонде было объявлено Саммит Linux 2004,[2][3] Саммит по аутсорсингу и программному обеспечению 2004 г.[4] и Open Source Forum Russia 2005.[5] Апробация разработки проектной документации в рамках данного фундамента проводилась в проектах, созданных с использованием Switch-технология, предназначенный для поддержки Программирование на основе автоматов.[6][7]

Анатолий Шалыто на Саммит Linux 2004, Хельсинки

Мотивация

Мотивация к созданию подробный документацией считается следующее:

  • качество программного обеспечения увеличивается
  • проверка программы упрощает
  • модификация проекта становится проще и безопаснее

Мотивация к оформлению документации открыто считается следующее:

  • проект становится менее зависимым от первоначальных авторов
  • другие люди могут легко понять структуру и поведение программы
  • повторное использование проектных решений становится проще и безопаснее
  • появляется возможность использовать реальный проект в учебных целях

Заявление

Foundation for Open Project Documentation дает проекту большую понятность и потенциал повторного использования, чем Фонд с открытым исходным кодом. Это слабо связано с Фонд свободного программного обеспечения. Проект OpenDoc также может быть коммерческим.

Основные принципы

  • Документация по проекту должна быть основой для исходного кода, но не наоборот.
  • Документация должна описывать не только конечный продукт, но и процесс создания.
  • Документация должна быть простой для понимания даже менее квалифицированным разработчикам, чем ее автор.
  • Документация должна быть доступна каждый раз, когда кто-либо изучает или изменяет проект.

Рекомендации

  1. ^ Шалыто А.Фонд открытой документации проекта в Code Project В архиве 2006-06-19 на Wayback Machine
  2. ^ Часть программы Linux Summit 2004
  3. ^ Шалыто А. Наумов Л. Фонд открытой проектной документации. Презентация для Linux Summit 2004
  4. ^ Четвертый российский саммит по аутсорсингу и программному обеспечению
  5. ^ Фотографии с Open Source Forum Rissua 2005
  6. ^ Проекты, созданные по технологии Switch, с открытой проектной документацией.
  7. ^ Проекты, созданные с помощью инструмента UniMod с открытой проектной документацией.

внешняя ссылка