Пишем и актуализируем архитектурную документацию

Тезисы

Архитектурные документы, high-level и low-level design docs, SDD, ADR... Документация, описывающая внутреннее устройство системы — сложная и обширная область. Такие документы сложно писать и дорого поддерживать.

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

Мы поговорим вот о чем:

  • Зачем вообще нужна архитектурная документация и каковы критерии ее качества.
  • Что такое «глубина описания системы» и нужно ли думать о ней в процессе написания архитектурной документации.
  • Помогают ли докстринги и Javadoc-комментарии в понимании устройства системы.
  • Фреймворки написания архитектурной документации arc42, C4, ADR, стандарты IEEE 1016 и IEEE 42010.
  • Как поддерживать актуальность архитектурной документации.

Аудитория

Everyone.

Уровень сложности

Middle.



Оцените доклад

Запись доклада

documentat.io

Семён Факторович

Был С++-разработчиком, а потом стал техписателем.

Уже 11 лет пишет документацию, руководит документационными командами, и учит других делать то же самое.

C 2018 года — основатель и руководитель documentat.io: компании заказной разработки документации и документационного консалтинга.

Был С++-разработчиком, а потом стал техписателем.

Уже 11 лет пишет документацию, руководит документационными командами, и учит других делать то же самое.

C 2018 года — основатель и руководитель documentat.io: компании заказной разработки документации и документационного консалтинга.

Другие спикеры секции LiveChannel