Guest
Архитектурные документы, high-level и low-level design docs, SDD, ADR... Документация, описывающая внутреннее устройство системы — сложная и обширная область. Такие документы сложно писать и дорого поддерживать. В этом небольшом докладе мы рассмотрим этот вид документации глазами технических писателей, разберем несколько практик документирования архитектуры, применяемых крупными российскими компаниями, а также сделаем обзор индустриальных стандартов и фреймворков написания такой документации. Мы поговорим вот о чем: - Зачем вообще нужна архитектурная документация и каковы критерии ее качества. - Что такое «глубина описания системы» и нужно ли думать о ней в процессе написания архитектурной документации. - Помогают ли докстринги и Javadoc-комментарии в понимании устройства системы. - Фреймворки написания архитектурной документации arc42, C4, ADR, стандарты IEEE 1016 и IEEE 42010. - Как поддерживать актуальность архитектурной документации. Сайт –
