|
Документирование не должно начинаться тогда, когда разработка программы закончена. Оно должно выполняться одновременно с разработкой программы, начиная с этапа постановки задачи. Независимо от того, насколько хороша программа, она будет работать только в том случае, если для ее использования имеются надлежащие инструкции. Даже если программа предназначена для индивидуального пользования, следует написать инструкцию, чтобы не забыть некоторых деталей, касающихся ее работы. Если же программа предназначена для непрограммистов, необходимы хорошо составленные подробные инструкции.
Начинайте документирование на стадии разработки программы.
Программы не являются физическими объектами, которые можно понять, дотрагиваясь до них руками. Более того, если программа находится внутри машины, ее нельзя даже увидеть. Для больших программ бесполезно пытаться использовать листинг в качестве документации. Листинг программы либо слишком длинный, чтобы его можно было прочитать, либо требуется приложить чрезмерные усилия даже в случае коротких программ, чтобы представить, что же делает программа.
Плохо документированная программа должна быть исследована группой специалистов, состоящей из врача, детектива и археолога. Детектив соединяет неполную документацию, врач ставит диагноз, а археолог изучает исторические документы в виде старых распечаток. Так как для понимания плохо документированных программ необходимо владеть перечисленными специальностями, нет ничего удивительного в том, что программу обычно выбрасывают и переписывают.
⇐2.19. Использование программ || Оглавление || 2.21. Переписывание программ⇒
|