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

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

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

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

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

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

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

Transcript

  1. 2.

    2 1 Своевременное документирование - Что даёт? - Как? Документирование

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

    Дано: Продукты – 3 шт. Проекты в разработке – 4шт.

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

    Польза своевременного документирования: - Документирование не только решений, но ошибок;

    - Сокращение этапов внедрения; - Упрощение процесса изменения продуктов; - Повышение уровня знаний сотрудников о продуктах. 6
  4. 7.

    7 Исследование Разработка Внедрение Производство Эксплуатация Изменение Проектная Проектная, Конструкция,

    Электроника, Испытания, Сопроводительная Проектная, Методики Конструкция, Электроника, Методики, Стенды Поддержка, Багтрекер Проектная
  5. 8.

    Хорошо знать в начале проекта то, что должно быть в

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

    Кейсы, когда необходимо полное документирование: - Продукт развивается по фидбэку;

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

    Как начать документировать «из памяти»? - Создайте карту продукта; -

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

    Своевременное документирование - Спасёт опыт ошибок; - Сократит общую длительность

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