Предисловие Команда, в которой я сделала свои первые шаги на поприще написания промышленного кода, занималась разработкой удобного API к функциональности...

Пару раз понадобилось встроить в сайт справочную систему. Простенькую, с тремя колонками — общее меню, текущая статья и меню содержания статьи. Поиски готового...

Ведение документации для тестирования в Google-доках и Google-таблицах — не лучший способ работы с тестовой документацией. Такой подход имеет свои недостатки. В...

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

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

Вторая часть статьи об использовании подхода документация как код.Первая часть --> читатьУстановка и настройкаПоскольку большая часть команды использует Linux на своих рабочих станциях, примеры...

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

Как мы боролись с документированием API на наших проектах, и как мы немного сошли с ума У вас на проекте порядок с документацией на API? Скорее всего нет. И в нашей компании порядка не было. Не будем...

Всем привет, сегодня хочу поделиться с вами библиотекой для создания документации для Angular проектов которую я не так давно выпустил. Зачем? Работая на разных проектах в разных конторах, или...

Одной из малоприятных, но, увы, распространённых болезней, сопровождающих человека, который работает техническим писателем, является синдром хронического помешательства. Признаки заболевания обычно...

Всем привет, меня зовут Женя Колесников, я из команды Yandex Infrastructure. Сегодня я расскажу, как мы пришли к написанию документации в концепции Docs as Code, придумали для этого набор...

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