How to Champion Investments to Improve Documentation
Сложно поспорить с тем, что хорошая документация ускоряет работы разными способами (упрощает получение знаний, ускоряет процессы за счет их описания, ускоряет разработку за счет описания контекстов, бест-практисов и все такое). Но при этом в большинстве команд документации уделяется очень малое время.
Ситуация примерно как с рефакторингом. Все понимают, что это важно, но все сфокусированы на бизнес-задачах.
В данной статье дается несколько советов по тому, как поставить процесс документирования в команде.
2 стратегии для изменения процессов:
- Документируйте то, что приносит много боли. Люди часто что-то спрашивают в чатиках ? Есть какой-то процесс, занимающий много времени и который лежит целиком в головах людей? Опишите это!
- Вся новая документация должна быть безупречной. Смиритесь с тем, что документация к старым системам будет плохой. Возможно вы с этим уже жили годами, так что даже не заметите разницы.
Эти стратегии следует комбинировать друг с другом, принимая решения о том, что и как документировать.
Также рекомендуется выделить людей, которые бы следили за тем, что эти стратегии соблюдаются и которые бы говорили всем, где и как следует описать документацию.
