3.7.3 Изменения документации

iDevice ikoon 3.7.3 Изменения документации

Меняются требования, меняются системы и вместе с ними должна изменяться и документация. Потому что хуже, чем отсутствие документации может быть только документация с ошибками. Однако когда документация меняется очень часто, обновление отдельной основной документации является объёмной и сложной работой. Легко появляются места, где логические связи, бывшие ранее, теряются при внесении изменений. Если же необходимо соответствие между системой и документацией необходимо сохранить, то одним их способов может быть следующий: необходимо начинать внесение изменений в саму документацию и обновлять все соответствующие её части, которые с этими изменениями связаны. И только после этого вносить изменения в саму систему.

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