Документирование

Введение
ПКПО живет документацией. Документация может быть отделена от программного кода, а может быть тесно с ним связана.Для примера, представьте, что вам надо войти в команду по работе над проектом, который делается уже год, и еще будет полгода создаваться. Вам потребуется вникнуть во весь процесс, изучить особенности предметной области, используемые методики. Или же Вампредоставили на сопровождение систему с исходным кодом, и требуется оперативно вносить в нее(систему) изменения. Без соответствуещего описания это сделать в приемлимые сроки невозможно.
В других областях инженерии огромную пользу принесло внедрение стандартов. То же саамое относится и к стандартам документирования при разработке ПО. Подобных стандартов множество. Но так же многие компании им полностью не следуют. Можно найти под слоем пыли как толстые тома руководств по стандартам документирования, так и краткие записки, описывающие основные подходы.

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

Наиболее важные стандарты по разрабатываются следующими организациями:
  • ГОСТ – российские государственные стандарты
  • IEEE – Институт инженеров по электротехнике и радиоэлектронике ( www.ieee.org )
  • ISO – международная организация по стандартизации
  • SEI – Институт технологий разработки программного обеспечения
  • OMG – консорциум по технологии манипулирования объектами ( www.omg.org )