TGViewer
Записки системного архитектора Записки системного архитектора @sysarchthoughts · 269 subscribers
Post #139 282
А давайте поговорим про документацию. Сколько раз вы слышали, что обязательно нужно разработать полную документацию по продукту, а без этого ничего не получится? Я такое слышал очень часто. И постепенно пришел к выводу, что слова "полная документация" нужно отнести к разряду ругательных, и в приличном обществе их использовать нельзя. Почему так? Да потому что самой полной и подробной документацией по программному продукту, описывающей его функционирование во всех деталях, являются его исходные коды. Но те, кто просят "полную документацию", обычно обижаются, когда их туда посылаешь. Так что слова "полная документация" никак не могут быть отнесены к приличным выражениям...

Лично я считаю, что как архитектурное решение не может быть правильным или неправильным (зато может быть уместным или неуместным, дорогим или даже нестандартным), так и документация не может быть полной или неполной, зато может быть объемной или лаконичной, полезной или запутанной, а иногда даже и востребованной. И вместо того, что бы стремиться объемом создать иллюзию полноты, лучше стараться минимизировать объем, зато увеличивать удельную полезность документации.
#документация #мысливслух
  • 👍 6
More from @sysarchthoughts
  1. Aug 4, 2026Мне жена как-то сказала, что только в зрелом возрасте осознала трагедию сказки о рыбаке и…
  2. Jul 2, 2026Я не давлю. Я пытаюсь опереться.
  3. Apr 2, 2026Пригласили меня тут в жюри школьного проектного конкурса, и вот что хочу сказать: мало кто…
  4. Mar 22, 2026Как технические границы делают все бизнес-критичным? Ключевой вопрос, которому посвящена э…
  5. Mar 22, 2026Неуловимо напоминает "основной закон органической химии". Если смешать бочку мёда и бочку…
  6. Mar 10, 2026(продолжение рассуждений про больницу) Что мне тут понравилось, что беру на заметку. 1. Че…
Threads Profile ViewerView any public Threads profile without an account.Open ThreadLook →Writing with AI? Make it sound human.Metric37 rewrites AI drafts so they read naturally. Free AI detector, 1,500 words free.Try Metric37 →