К книге
Настоящий CTO: думай как технический директор11. Документация. 11.4. Рекомендации
80%
11. Документация. 11.4. Рекомендации
265

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

• Тщательно выбирайте инструмент для вашей базы знаний, он должен предоставлять как можно больше функционала.

• Создайте шаблоны, чтобы можно было быстро добавлять новые страницы. Гораздо проще редактировать что-то, чем создавать с нуля.

• Начинайте с малого и двигайтесь не спеша. Это марафон, а не спринт.

• Поощряйте добавление в документацию информации из электронных писем и чатов.

• Быстро создать контент можно, записав видео или скринкаст.

• Описывайте, что делает исходный код, во время его ревью.

• Отрабатывайте и тренируйте все процессы управления вашим комплексом.

Предыдущая главаГлава 265 из 332Следующая глава