Какой глубокий вопрос! Без дураков. Могу предложить следующее. Все тут знают что я старый закостенелый апологет персональной ответственности.
Что-то типа, я получил эту задачу из рук моего суверена и я решаю ее для него.
Все кто хочет знать как что внутри - идут лесом.
Это мой феод.
Естественно, в том что сделаю я, будет овердофига всяких переключателей
и подстроечников. И даже не подумаю вносить их в документацию.
По сути, документация будет интерфейсом модуля.
Тем, что суверену безусловно необходимо, чтобы подключиться.
Это проекция идеологии на один из частных вопросов.
Возможны и другие идеологии. Часть из них предполагает полное отсутствие инкапсуляции.
И будет требовать даже не краткого упоминания всех служебных тумблеров,
а возможность без меня вставить какие-то чужие дочерние карты и на ходу перекоммутировать часть цепей.
(это я так вижу себе открытое ПО)
Неупомянутый тумблер, в такой идеологии - преступление.
Но по факту, в "открытых" проектах с документацией все сильно хуже чем в "феодальных".
Слишком много на себя берут. И там где у меня - изящный, легко читаемый текст,
с хорошо продуманными картинками "для моего синьора", у них - отписка для непойми кого,
на обрывках прошлогодних конфетти. Еще и не факт что не устаревшая.
Потому что не хватит мотивации.
Они - заявили цель, но не достигли, я - от задачи открестился, но "тому кому действительно надо - покажу".
Не говоря о том, что в одном случае есть я, и задавая правильные вопросы, легко получить правильные ответы,
то в другом, обычно трудно определить кто что знает, и как его спросить вообще.