С той стороны зеркального стекла: взгляд на документацию с точки зрения бизнеса (Максим Строев)

http://docfactor.ru
http://documentat.io

DocFactor'17, конференция о технической документации. 26 ноября 2017, Новосибирск, НГУ.

С той стороны зеркального стекла: взгляд на документацию с точки зрения бизнеса. Максим Строев, HDsoft/Zodiac Interactive, R&D Director

Видео: https://www.youtube.com/watch?v=Xvl0vE8ilq4

Давайте ненадолго отвлечемся от изучения технической документации с точки зрения ее создателей и посмотрим на нее глазами руководителей и владельцев IT-компаний.

В этом докладе мы поговорим о следующем:

- Приносят ли технические писатели деньги своим компаниям?
- В какой момент документация становится конкурентным преимуществом компании?
- Могут ли хорошо настроенные процессы документирования быть гарантией безопасности бизнеса?
- Почему при общении с бизнесом нужно использовать термин «управление знаниями», а не «техническая документация/техническая коммуникация»?

Transcript

1. С той стороны зеркального стекла Взгляд на техническую документацию с точки зрения бизнеса Максим Строев HDsoft/Zodiac Interactive, R&D Director
2. Zodiac Interactive • ПО для индустрии кабельного телевидения • Полный software stack для ТВ-приставок (ARM/MIPS, Linux, embedded C++) • Серверные и инфраструктурные решения для операторов ТВ • Продуктовые решения, заказная разработка на их основе • R&D-активности
3. Виды бизнес-процессов • Per-project • Непрерывная производственная деятельность
4. Per-project • Любой проект делается «с нуля»: каждый раз как в первый раз • Простая декомпозиция, простые постановки задач исполнителям • Процессы часто линейны: вдвое больше разработчиков — вдвое меньше время на разработку
5. Per-project • Документационные задачи очевидны и легко формализуемы • И часто вообще отчуждаемы • Документация — один из проектных артефактов, который продается заказчику или включается в итоговую цену продукта
6. Непрерывная производственная деятельность • Сложный монолитный бизнес-процесс, в рамках которого реализуются разнотипные проекты, R&D и операционная деятельность • Декомпозиция на задачи сложна и неочевидна • Процессы нелинейны: малое изменение входных параметров может многократно изменить стоимость/сроки/эффективность
7. Непрерывная производственная деятельность • Документация глубоко интегрирована во все процессы: регламент, контроль, приемка...
8. Непрерывная производственная деятельность • Документационные задачи • слабо отчуждаемы • не имеют четкого выражения в деньгах (редко продаются заказчику) • могут иметь неочевидные постановки
9. Сложность разработки • Многочисленные зависимости • Legacy code base • Технологические риски • Новые, доселе неизвестные предметные области (каждый день!)
10. Сложность разработки • Нелинейность (R&D-активности плохо параллелятся) • Цена ошибки со временем растет экспоненциально • Понять техническую нереализуемость решения лучше на этапе дизайна, а не после выпуска линейки нового железа под это решение
11. Пространство принятия решений Набор фактов, их существенных характеристик и взаимосвязей между ними, позволяющий принимать решения (организацонные, технические и т.д.)
12. Пространство принятия решений • Требования • Полнота • Структурированность и удобство доступа • Метрики (решение А на 25% лучше решения Б)
13. Пространство принятия решений • Критерии качества • Правильность принятого решения (в т.ч. и в терминах денег) • Скорость принятия решения
14. Пространство принятия решений • Применимо на всех уровнях • Бизнес и компания • Развитие продукта • Работа отдела/команды • Конкретные архитектурные решения в конкретном программном компоненте • Реализация конкретного алгоритма
15. Пространство принятия решений • Хорошо работающее ППР — основа успешности бизнеса • Ошибки в принятии решений приводят к убыточным проектам, неверной стратегии развития и гибели компании • ППР — это то, во что компания готова вкладываться
16. Knowledge management Управление знаниями — набор техник по наполнению пространства принятия решений и обеспечению доступа к нему
17. Knowledge management • Извлечение фактов • Их анализ, обработка, упорядочивание и структурирование • Отслеживание актуальности • Обеспечение удобного доступа и поиска
18. Knowledge management • Извлечение фактов • Их анализ, обработка, упорядочивание и структурирование • Отслеживание актуальности • Обеспечение удобного доступа и поиска Техписатели, узнаете себя?
19. Knowledge management • Создание (или управление) технической документацией — это KM на каком-то уровне иерархии задач в компании • Относитесь к документации как к способу формировать пространство принятия решений на вашем уровне
20. Knowledge management • Многие компании не выделяют отдельных людей на высокоуровневый KM (но очень хотели бы их иметь) • Техписатель может вырасти в специалиста по KM на более высоких уровнях
21. Что делать? • Относитесь к своей документационной работе как к knowledge management • Если интересно — поднимайтесь на более высокие уровни KM • Покажите руководству, что занимаясь этой деятельностью, вы сможете приносить/экономить деньги компании