5. Пиши документацию

Второй по важности, после написанного кода, продукт работы программиста — это документация.

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

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

Документацией могут быть не только описания того, что есть, но и то, как этим пользоваться и в какую сторону это развивать. Документация должна быть не только на то, что уже сделано и используется, но и на проведённые, но не получившие продолжения proof of concept и небольшие эксперименты.

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

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

Мнение менторов

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

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

Cookies помогают нам предоставлять наши услуги. Используя наши услуги, вы соглашаетесь с использованием наших cookies.