Pull to refresh
17
0
Теодора Малевинская @theos_deus

Head of Technical Writing at Tinkoff

Send message

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

Reading time8 min
Views18K

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

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

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

Читать далее
Total votes 47: ↑45 and ↓2+51
Comments6

Information

Rating
Does not participate
Location
Москва, Москва и Московская обл., Россия
Works in
Registered
Activity

Specialization

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