Как стать автором
Обновить
17
0
Теодора Малевинская @theos_deus

Head of Technical Writing at Tinkoff

Отправить сообщение

Составляем документацию разработчика пошагово без диет и тренировок

Время на прочтение8 мин
Количество просмотров19K

Недостаточно просто написать инструкции — важно, как, в каком порядке и где вы их разместите. 

Привет! Это Теодора — технический писатель Платформы, жизненно важного департамента Ozon. Документация для нас имеет большое значение, потому что вся компания пользуется нашими разработками: инфраструктурой as a service; фреймворками и библиотеками; инструментами для работы с базами данных и аналитикой и прочим. Сотни инженеров ежедневно обращаются к нашим сервисам и нуждаются в их описании.

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

Читать далее
Всего голосов 47: ↑45 и ↓2+51
Комментарии6

Информация

В рейтинге
Не участвует
Откуда
Москва, Москва и Московская обл., Россия
Работает в
Зарегистрирована
Активность

Специализация

Technical Writer, Knowledge manager
Lead
Git
Golang
Markdown
Static Site Generators