Поддержка поддержки. Как настраивать процессы документирования (Константин Медведев)

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

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

Поддержка поддержки. Как настраивать процессы документирования. Константин Медведев, Тион, руководитель отдела сопровождения продуктов

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

Поделюсь опытом создания отдела документирования в крупной производственной компании. Расскажу про то, как и зачем нужно начинать документировать в любой непонятной ситуации. Покажу шишки от граблей и поясню, как их можно не получать и чем их лечить.

Transcript

1. Поддержка поддержки. Документирование в условиях
   полного цикла выпуска «железа»
   Медведев Костя
   DocFactor 2017
   1
   

   View Slide

2. 2
   1 Своевременное документирование
   - Что даёт?
   - Как?
   Документирование из памяти
   - Когда нужно и в каком объёме?
   - Как?
   2
   

   View Slide

3. География Математика
   3
   

   View Slide

4. 4
   Продукты
   

   View Slide

5. Дано:
   Продукты – 3 шт.
   Проекты в разработке – 4шт.
   Желание документации – ∞
   Технический писатель – 1 шт.
   Менеджер проектов – 1 шт.
   Найти:
   Способ для
   документирования проектов;
   Документацию на продукты.
   Решение:
   Копать!
   Чем?
   Откуда?
   До когда?
   5
   

   View Slide

6. Польза своевременного документирования:
   - Документирование не только решений, но ошибок;
   - Сокращение этапов внедрения;
   - Упрощение процесса изменения продуктов;
   - Повышение уровня знаний сотрудников о продуктах.
   6
   

   View Slide

7. 7
   Исследование
   Разработка
   Внедрение
   Производство
   Эксплуатация
   Изменение
   Проектная
   Проектная, Конструкция, Электроника,
   Испытания, Сопроводительная
   Проектная, Методики
   Конструкция, Электроника,
   Методики, Стенды
   Поддержка, Багтрекер
   Проектная
   

   View Slide

8. Хорошо знать в начале проекта то, что должно
   быть в момент его завершения.
   Как сделать всё правильно?
   - Составить карту продукта;
   - Договориться с менеджером проекта;
   - Объяснить подход разработчикам;
   - Назначить «хранителя» документации.
   8
   

   View Slide

9. Отношение к документации снаружи и внутри отдела
   9
   

   View Slide

10. Кейсы, когда необходимо полное документирование:
    - Продукт развивается по фидбэку;
    - Часть продукта планируется передать подрядчикам;
    - Планируется выпуск новой версии.
    Кейсы, когда хватит минимального и достаточного:
    - Нормативная документация;
    - Требования регламентов;
    - Технические характеристики.
    10
    

    View Slide

11. Как начать документировать «из памяти»?
    - Создайте карту продукта;
    - Соберите имеющуюся документацию;
    - Донесите свою цель до разработчиков;
    - Заходите с небольшими спринтами.
    Польза
    - У разработчика «размыливается» глаз;
    - Можно найти ошибки как в том, что уже есть,
    так и в том, что разрабатывается.
    11
    

    View Slide

12. Своевременное документирование
    - Спасёт опыт ошибок;
    - Сократит общую длительность проекта;
    - Повысит уровень знаний сотрудников о продуктах.
    Документирование из памяти
    - Необходимо определить, когда нужно
    документировать полностью, а когда – нет;
    - Скорей всего окажется полезным.
    12
    

    View Slide

13. Спасибо за внимание!
    DocFactor 2017
    13
    

    View Slide