Что должно быть в базе знаний, чтобы всем было хорошо

Привет, Хабр! Я Катя из команды техписателей в Ozon. Мы продолжаем расти и развиваться, поэтому вслед за статьёй о видах документации хочу разобрать, какие проблемы внутри команды можно документацией решить.

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

fa27d6381e028e8282be2e67ff149cb4.jpg

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

Дальше моя личная подборка частых болей, напишите в комментарии своих фаворитов

© Habrahabr.ru