Оценка и стандартизация документации: как сделать её инструментом, а не проблемой
Дмитрий Никитин из компании Ви.Тех рассказал об оценке и стандартизации документации. Когда команда начала расти, у каждого появилось своё представление о том, какой должна быть документация. Стало сложно ориентироваться, и они поняли, что нужен единый подход.
Документация – это не просто текст, это инструмент, который должен помогать, а не создавать проблемы.
Проблема в том, что с увеличением числа сервисов усложняется поддержка информации в актуальном состоянии. Они решили стандартизировать процесс и выделили шесть основных блоков, в том числе интеграции и архитектуру. Но как сделать так, чтобы документация стала полезной для всех, не потеряв актуальность? Для этого ребята разработали систему оценки качества. Пять критериев, которые помогают объективно оценивать документацию, и вес каждой части показывает, на что следует обратить внимание в первую очередь.
Теперь у них есть прозрачная метрика, мотивирующая команды поддерживать порядок. Это несложно, а скорее полезное упражнение для всех, кто хочет улучшить систему документации в своей компании.
Представьте, что вы в библиотеке, где книги разбросаны и половина из них неактуальна. Так выглядела наша документация после перехода на микросервисы. Мы ожидали порядка, но столкнулись с хаосом. Тогда мы решили изменить ситуацию, разработав стандарты для оценки и улучшения документации.
В этом докладе:
1) Обсудим, как создать и внедрить методику оценки покрытия сервисов документацией.
2) Разберем, как оцифровать этот показатель и использовать его для улучшения качества документации.
3) Поговорим о том, как мотивировать команду на поддержание документации в актуальном состоянии и интеграции новых стандартов.
4) Поделимся примерами успешного применения подхода и результатами, которые мы получили.
Будет полезно тимлидам и аналитикам уровня мидл и выше.
Доступно только после покупки 😊
