Системный подход к организации процессов документирования в продуктовой ИТ-компании (Виктория Кондрашук)

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

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

Системный подход к организации процессов документирования в продуктовой ИТ-компании. Виктория Кондрашук, Финансовые информационные системы, технический писатель

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

Мой доклад – об улучшении качества продукта путем улучшения качества документации, о влиянии технического писателя на производительность труда и о системном подходе к процессам документирования.

Я расскажу о следующем:

- как хорошая документация уменьшает энтропию и увеличивает производительность труда;
- как выделить основные процессы документирования, типы основных документов и сделать четкое разделение операционных задач и задач развития;
- как правильно расставить приоритеты в условиях ограниченных ресурсов;
- о простых, но эффективных инструментах создания и хранения документации: JIRA, Confluence, SVN;
- о постановке задач на разработку документации и о контроле их выполнения.

Transcript

1. Системный подход к организации
   процессов документирования
   в продуктовой IT-компании
   Виктория Кондрашук
   Технический писатель
   ГК «Финансовые информационные системы»
   26 ноября 2017
   

   View Slide

2. View Slide

3. Цель продукта:
   Возврат задолженности в минимальные сроки при минимальных
   затратах
   Целевая аудитория продукта:
   Банки и кредитные организации
   Сайт: fisgroup.ru
   FIS Collection System
   

   View Slide

4. О чем доклад
   Как улучшить качества продукта путем улучшения качества
   документации;
   О влиянии технического писателя на производительность труда;
   О системном подходе к процессам документирования.
   

   View Slide

5. План доклада
   1. Основные понятия: производительность труда, эффективность, энтропия.
   Как хорошая документация уменьшает энтропию и увеличивает
   производительность труда.
   2. Как выделить основные процессы документирования и типы основных
   документов. Как правильно расставить приоритеты в условиях
   ограниченных ресурсов.
   3. Основные инструменты работы: JIRA, Confluence, SVN. Постановка задач
   на разработку документации и контроль. Хранение документации.
   4. Системный подход к организации процессов документирования.
   

   View Slide

6. Целевые функции
   Сбор и хранение информации, связанной с взысканием
   просроченной задолженности;
   Автоматизация деятельности различных служб банка при
   осуществлении претензионной работы: call-центр, служба
   безопасности, юристы, залоговая служба и др.;
   Контроль над процессом взыскания;
   Формирование отчетности для анализа эффективности работы,
   выявления наиболее успешных кредитных продуктов.
   

   View Slide

7. Архитектура системы
   OCI 8
   HTTP/HTTPS
   Oracle DBLink/Oracle HS/
   Файлы *csv
   Веб-
   сервер
   Apache
   Браузер
   Транспорт
   WEB –
   шлюз
   PHP
   Интерфейс
   FCS
   Веб -
   интерфейс
   Рабочее место
   БД FCS
   Внешний источник информации SMS - шлюз
   SMS - шлюз
   Основной
   модуль
   БД источника
   Модуль
   импорта
   Модуль по
   работе с AQ-
   Очередями
   Модуль
   Подраздел
   ений
   Модуль
   Стратегий
   Модуль
   Бизнес-
   процессов
   Модуль
   Взаимодей
   ствия с КА
   Модуль
   интеграци
   и с КЦ
   Модуль
   отчетности
   CTI-gate
   БД Контакт
   центра
   Модуль
   интеграци
   и с SMS
   JDBC/SMPP HTTP
   Active Directory
   Active
   Directory
   LDAP/LDAPS
   Kerberos
   

   View Slide

8. View Slide

9. Что нам нужно знать
    Информация о системе
    Правила работы
   

   View Slide

10. Что нужно знать: Где найти:
     Как система работает сейчас
     Как система будет работать
     Как проверить, что все работает правильно
     Как изменялась система
     И пр.
     Пользовательская и техническая документация
     Постановки на разработку
     Тест-кейсы
     Релизная документация
     Проектная документация
    Информация о системе
    

    View Slide

11. Что нужно знать: Где найти:
     Что делать
     Какие сроки
     Кто ответственный за выполнение
     Кто ответственный за контроль
     Внутренние регламенты и инструкции
    Правила работы
    

    View Slide

12. Проблемы в документации
    Не полная
    Не понятная
    Противоречивая
    Плохо структурированная
    Сложно найти
    Отсутствует
    

    View Slide

13. Эффективность
    Результат
    Затраты
    Производительность труда= Операционный доход
    Человеко−часы
    

    View Slide

14. Основные операционные расходы в
    продуктовой ИТ-компании
     Сбор и анализ требований
     Написание постановок и согласование
     Реализация (и администрирование)
     Тестирование
     Документирование
     Менеджмент
     Исправление багов
    Документация
    

    View Slide

15. Проблемы документации
    приводят к увеличению человеко-
    часов на следующие работы:
     Исправление и поиск багов
     Работа аналитика
     Разработка
     Тестирование
     Документирование
     Менеджмент
    Снижение
    лояльности
    Заказчиков
    Результат
    

    View Slide

16. Задачи технического писателя
    • Операционные
    • Обновление пользовательской и технической документации
    • Подготовка WhatsNew
    • Оформление текст-кейсов на релизные доработки
    • Подготовка новых документов
    • Не операционные (Развитие)
    • Внедрение новых процессов
    • Внедрение новых регламентов и правил работы
    • Шаблонизация документов (инструкции, постановки на разработку)
    • Выработка единого стиля
    

    View Slide

17. Основные инструменты
    Jira
    Confluence
    SVN
    Sphinx (нечеткий поиск) - планируется
    

    View Slide

18. Задачи, которые решает Jira
     Постановка и планирование задач
     Просмотр история выполнения задачи
     Обеспечение взаимосвязей и иерархии задач
     Учет рабочего времени сотрудников
     Ведение проектной деятельности
    Контроль за выполнением задач
    

    View Slide

19. View Slide

20. View Slide

21. View Slide

22. View Slide

23. View Slide

24. View Slide

25. View Slide

26. Задачи, которые решает SVN
     Хранение документов
     Хранение истории изменений
     Контроли за изменениями
     Сравнение двух версий документов
     Откат изменений
    

    View Slide

27. View Slide

28. Задачи, которые решает Confluence
     Хранение внутренних регламентов и правил работы
     Хранение внутренней информации об устройстве системы
     Хранение истории изменений внутренних документов
     Структурирование информации
    

    View Slide

29. View Slide

30. Требования к системному подходу
     Решение задач ориентировано на роль, а не на человека
     Есть четкие формализованные правила работы
     Индивидуальная ответственность за решение задач
     Есть формализованные сроки решения задач
     Есть итоговый контроль
    

    View Slide

31. Критерий качества
    Ты все делаешь правильно,
    если это может работать без тебя
    

    View Slide

32. Спасибо за внимание!
    почта: vika_kondrashuk@mail.ru
    соц.сети: vk.com/vika_kondrashuk
    

    View Slide