Документация нужна. Точка. На этом всё, расходимся. На самом деле, если без шуток, что такое техническая документация? Зачем она нужна? Вопросы интересные. Если отвечать на них бюрократическим языком, то получится длинно, важно и непонятно. Поэтому мы попробуем ответить…
В этой статье я постарался обобщить свой опыт в создании документации для различных архитектур, таких как монолитная и микросервисная. Я описал, какие диаграммы и схемы действительно полезны для системных аналитиков, архитекторов и разработчиков в зависимости от выбранной архитектуры проекта, а также какие моменты часто упускаются на практике. Читать далее
Техническая документация — важный элемент любого сообщества, в том числе при продвижении продукта. Документация является средством первого прямого контакта с разработчиками и пользователями, заинтересованными в использовании продукта. Чем лучше документация, тем больше шансов, что они вернутся и будут участвовать в жизни сообщества. В этой статье рассмотрим распространенные ошибки, которые можно допустить при создании документации. Читать далее
Вопрос о необходимости документации при разработке вызывает много споров. В динамичном мире IT, где изменения стремительны, я часто слышал холиварные обсуждения: а так ли необходима документация?Кто-то считает, что программный код сам по себе уже исчерпывающая документация. В…