Применение практики «Документация как код» для документирования заказных приложений (Николай Поташников, SECR-2018)

Короткая ссылка: 20181013DB

Докладчик: Николай Поташников

Умение создавать хорошую документацию выделяет разработчика среди конкурентов. Умение создавать документацию эффективно, не затрачивая больших усилий, не так заметно, но не менее важно, особенно если создается сложный программный продукт, а заказчик оказался требовательным.
Наш 20-летний опыт создания заказных приложений позволяет с уверенностью сказать, что практика «Документация как код» является наилучшей для сокращения усилий при документировании, причем как в маленьких, так и в очень больших проектах с любым уровнем формализации требований. В докладе я расскажу о том, как эта практика применяется у нас в компании.
В своей работе мы ориентируемся на технологическую цепочку Asciidoctor, но речь пойдет об общем подходе к процессу подготовки программной документации, его организационной и технологической составляющих.