Самая лучшая документация это та, которая пишется ДО того, как приступили к реализации идеи. Такая документация содержит основные идеи автора решения, варианты способов решений и позволяет использовать эти идеи при дальнейшем развитии.

Всякая документация, созданная ПОСЛЕ реализации будет устаревшей. Потому, что:

  1. Появляется желание передать максимально точно способ реализации, но не ключевую идею.
  2. Будет слишком много мелких деталей не добавляющих ценности.
  3. Из-за того, что реализация УЖЕ сделана, то документация может вообще не содержать нужной информации, если это явно не зафиксировано в договоре. “Зачем писать? И так понятно, как работает!”, “Зачем что-то писать? Оно же работает!”.

Правила документирования:

  1. При документировании решения пользуйтесь правилом «Необходимо и достаточно»
  2. Проектируйте в документе до того, как приступили к реализации, используйте удобные средства для такого подхода.
  3. Используйте документы, как отправную точку для обсуждений.
  4. Подумайте письменно в документе, перед тем, как что-то создавать в Потоке Реализации.