28 расширений VS Code для разработки документации

Плагины Vs Code, без которых техническим писателям и разработчикам документации жить можно, но сложно. В подборке — линтеры, форматирование, работа с git, проектирование API, подготовка схем и милота для удобной разработки. Читать дальше…

Как мы ведём документацию рядом с кодом

В Альфа-Банке мы уже больше 5 лет ведём документацию рядом с кодом. Но она используется не для всех проектных документов. Дело в том, что документация у нас делится по слоям: фронт, миддл и бэкенд. Если с миддлом — слоем микросервисов — всё хорошо…

Концептограмма – как метод повышения эффективности технической документации

Аналитик Группы «Иннотех» Константин Котельник задумался о том, как упростить разработчикам восприятия технической документации, а также помочь новому поколению с клиповым мышлением эффективно работать с большими объёмами информации. О возможности появ…

Документирование кодовой базы. Зачем и как?

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