Перейти к основному содержимому

О важности документации

·214 слов·2 минут
Оригинал опубликован в Telegram

До Яндекса один техлид дал мне вредный совет: “Разработай свою CMS, подсади на нее всю компанию и стань тем единственным, кто сможет ее развивать”.

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

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

Мой опыт работы документатором подсказывает, что с документацией можно работать также, как с кодом: писать, рефакторить, тестировать, деплоить.

Но как и с программированием, тут тоже важна практика.

Мне вспоминается серия из «Теории большого взрыва», в которой Леонард вспоминает, как Шелдон учился плавать с помощью Интернета. Обиженный Шелдон отвечает: «Я действительно учился плавать». На что Леонард говорит, что Шелдон учился плавать на полу. А тот возражает: «Навыки переносятся, мне просто было неинтересно пробовать в воде!»

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

Именно поэтому я всем вокруг повторяю, что важно публиковать технологические посты внутри Яндекса и снаружи, учиться описывать свои достижения к ревью и писать лаконичную документацию.

Тот, кто умеет структурно описывать свои мысли и решения, обладает конкурентным преимуществом. Порядок в мыслях — порядок в делах :)