ВУЗ:
Составители:
Рубрика:
126
3.8. Документирование
Документация выполняет как минимум две основные функции:
–
- напоминает разработчику о том, как устроена его программа;
– - объясняет пользователю, как правильно использовать программу;
– с помощью документации руководство проектом осуществляет управление
ходом выполнения проекта.
Особенно актуальна необходимость документации для сложных про-
граммных систем, когда разработку осуществляет большой коллектив спе-
циалистов. Основная проблема из-за недостаточности документирования,
особенно в малых прикладных разработках, выполняемых неспециалистами в
области программного обеспечения (прикладными программистами), проис-
текает из естественной склонности
к лени (знаменитый принцип "экономии
усилий") в сочетании с переоценкой возможностей собственной памяти. В
процессе работы над какой-то частью программы эмоциональный фон на-
столько велик, что кажется невозможным забыть в будущем все детали про-
исходящего процесса, а требование тратить время и усилия на составление
документации кажется надуманным и явно излишним
, тем более, что кажет-
ся, что программа вот-вот будет завершена, заработает, и какое кому дело до
того, как она устроена. Однако, проходит время (месяца-двух напряженной
работы над другими частями той же программы обычно достаточно), чтобы
сам разработчик потом гадал с недоумением, что означает какая-то перемен-
ная, при
каких условиях флаги и ключи принимают свои значения и т.п. В
этот момент мысль о необходимости как можно более подробного докумен-
тирования уже не кажется такой уж надуманной, но историю не повернешь
вспять. На следующем этапе все повторяется с завидной постоянностью.
Проблема документирования это пожалуй те "грабли", мимо которых никто
из практикующих программистов не проходит, в том числе и автор данных
строк, искренне надеющийся, тем не менее, что рассуждения на эту тему не
совсем бесполезны. Не исключено, что способность грамотно и своевременно
документировать процесс разработки есть неотъемлемый признак истинного
профессионализма (не только в сфере программирования).
Классификация документации на программное обеспечение
Специализированные фирмы-разработчики программного обеспечения
имеют специальные стандарты на то, какие виды документации обязательно
должны быть, что в ней должно отражаться, как оформлено и т.п. В разных
фирмах эти стандарты зачастую отличаются друг от друга. Не имея
возможности останавливаться на всех деталях, мы рассмотрим только
основные моменты, которые достаточно универсальны
и в той или иной
форме содержатся в каждых частных требованиях.
Страницы
- « первая
- ‹ предыдущая
- …
- 124
- 125
- 126
- 127
- 128
- …
- следующая ›
- последняя »
