16 прочтений · 1 год назад
Составляем документацию разработчика пошагово без диет и тренировок
Мы уже писали о своём опыте документирования проектов. Теперь заход от больших ребят, в несколько другой плоскости. Начинается статья с интересной блок-схемы, где отображены типичные вопросы по документации: — Есть ли у вас документация? — Актуальна ли она? — Легко ли её найти? — Читает ли её кто-то? — В одном ли месте всё собрано? В зависимости от ваших ответов на эти вопросы, автор рекомендует посмотреть те или иные пункты статьи. В них даются конкретные практические советы. Часто полезная информация разбросана по разным источникам. Как подключиться к инфре писали в общем чате, нюансы работы с сервисом написали в личку, R&D таки зафиксировали в конфлюенс...