В декабре специалисты TechWriters.ru посетили встречу технических писателей в Яндекс. В этот раз Мини-Гипербатон был посвящён метрикам эффективности документации.
Конспект, презентации и другие материалы
Опытом и знаниями поделилась команда Яндекса, Анастасия Агеева из Intel и Александр Лебедев из компании «Философт».
Встреча прошла интересно. было много полезных докладов и знакомств.
Программа
18:00 Регистрация
18:30 Методы оценки трудозатрат и сроков документирования или Как правильно отвечать на неправильные вопросы
Александр Лебедев Философт
Заказчика любой работы интересует, сколько она стоит и когда будет выполнена. Документирование здесь — не исключение, однако в случае с ним задача часто оказывается настолько размытой, что оценить её — отдельная небольшая работа, иногда даже невыполнимая на текущей стадии развития объекта документирования. Как же поступить в ситуации, когда ответ нужно дать обязательно, а вопрос поставлен некорректно?
В докладе будут рассмотрены типовые случаи постановки задач на документирование, способы их конкретизации и методы оценки трудозатрат и сроков.
19:00 Как измерить качество документации и эффективность её разработки. Часть 1
Как правило, о производственных метриках документации начинают задумываться компании, в которых уже устоялись процессы и налажен массовый выпуск документации. В какой момент этот вопрос становится важным и почему? Это формальность или полезная необходимость? Какие метрики можно применять к процессам документирования? Эти вопросы мы рассмотрим в первой части нашего доклада.
Далее подробно рассмотрим:
- подходы и методики к измерению эффективности процесса разработки и поддержки документации;
- метрики для измерения качества документации и влиянии качества на эффективность работы смежных отделов компании.
Традиционно наш доклад построен в формате How to.
Светлана Каюшина Яндекс
Юрий Никулин Яндекс
Антон Литвинов Яндекс
19:30 Перерыв
20:00 Как измерить качество документации и эффективность её разработки. Часть 2
Продолжение.
20:40 Кастомизация отчётов, или Как говорить на языке метрик без переводчика
Анастасия Агеева Intel
Как оптимизировать процессы сбора, обработки и представления показателей эффективности документации? Как реализовать механизм генерации отчётов, понятных и доступных пользователю без специальной подготовки?
Я поделюсь опытом моей команды в решении этих вопросов, расскажу о системе, которая позволяет объединять и визуализировать данные документационной аналитики из различных источников в динамических онлайн-отчётах. Мы также поговорим о том, как эти инструменты поддерживают основанный на данных (data-driven) подход к развитию документации.