Тезисы
Архитектурные документы, high-level и low-level design docs, SDD, ADR... Документация, описывающая внутреннее устройство системы — сложная и обширная область. Такие документы сложно писать и дорого поддерживать.
В этом небольшом докладе мы рассмотрим этот вид документации глазами технических писателей, разберем несколько практик документирования архитектуры, применяемых крупными российскими компаниями, а также сделаем обзор индустриальных стандартов и фреймворков написания такой документации.
Мы поговорим вот о чем:
Аудитория
Everyone.
Уровень сложности
Middle.
Был С++-разработчиком, а потом стал техписателем.
Уже 11 лет пишет документацию, руководит документационными командами, и учит других делать то же самое.
C 2018 года — основатель и руководитель documentat.io: компании заказной разработки документации и документационного консалтинга.
#codefestru #codefest2023 #CodeFest13