Документация. Когда не нужна документация?

1.

Документация

2.

Когда не нужна документация?
Нет достаточной мотивации
Документация ради документации, никогда не будет актуальной
Небольшой объем настроек
Для частного использования и небольших проектов держать в
голове настройки в no-code системах может быть проще, чем
вести подробную документацию
Есть альтернатива
Часто достаточно каких то простых вещей, например запись
экрана на 3-5 минут, с объяснением настройки

3.

Зачем это нужно нашей команде?
Организовать параллельную работу с одним проектом
нескольких сотрудников
Оперативно осуществлять поддержку аккаунтов
Быстро вспомнить что, как и зачем делалось
Видеть между объектами (например, в каких шаблонах
используются поля?)
Сохранить знания о проекте, если сотрудник уходит из
команды

4.

С чем мы столкнулись?
Какой формат\структуру выбрать?
Где вести документацию? ПФ или другой сервис?
Как поддерживать в актуальном состоянии?
Как заставить себя вести документацию и
тратить на неё меньше времени?
Как эффективно использовать данные?

5.

Структура. Что пробовали?
Описать все сущности в лоб.
Процессы. Шаблоны. Поля в шаблонах. Аналитики.
Статусы и т.д.
Почему не зашло:
● Много времени уходит на копипаст и описание, но
на выходе данные не такие ценные
● Сложно поддерживать в актуальном состоянии
● Непонятно куда записывать данные по процессу,
который затрагивает разные шаблоны, сущности в
ПФ. Приходиться либо дублировать, либо собирать
по частям информацию из разных мест.
● Нет общей картинки по аккаунту

6.

Структура. Что пробовали?
Описать всё схемами
Почему не зашло:
● Помимо основного процесса, есть много доп.функций,
которые нужны в разных ситуациях. Непонятно, куда
их положить на таких схемах, а делать свои схемы на
каждый возможный вариант – слишком трудозатратно
Нет общей картинки по аккаунту

7.

Структура. Что пробовали?
Сделать взаимосвязи между элементами в airtable
Почему не зашло:
● На выходе получилось очень полезно, но время
на создание и поддержание в актуальном виде –
несоизмеримо с полезностью.
Вывод: нужно автоматизировать такой сбор.
● Не понятно где описывать сами процессы
● Нет общей картинки по аккаунту

8.

Выбор основного сервиса. Требования
Документация – это, преимущественно, текст.
Поэтому мы искали максимально удобный сервис для совместной работы над текстовыми
документами.
Наши требования:
Удобный редактор. Много возможностей для форматирования
Простая работа с мультимедиа. Вставлять разными способами в разных форматах.
Возможность оставлять комментарии прямо по тексту в сносках
Инструменты для рисования схем
Гибкие настройки доступа к проектам (в том числе простой доступ по ссылке)
Доступная цена + низкий риск ухода с рынка
Использование API

9.

YoNote
(показать демонстрацию)
- Общая схема
- Схема по процессам
- Глоссарий
- Внутренние инструкции
- Шаблон описания функционалов
- API Связка с ПланФикс
-
Создание структуры
Создание страничек с функционалами
Обновление названий и статусов

10.

К чему мы пришли
Единая схема по аккаунту
Простые схемы по процессам
Описание Функционалов
Автоматизированный сбор данных для связей
аккаунтов (в разработке)

11.

Что в результате и какие планы
Так как нет возможности без привязки функционала закрыть
задачи– за год мы их насоздавали порядка 1000 штук – это
база для работы. Мы видим, какие из них стоит описать в
первую очередь, потому что по ним много обращений
Стараемся сразу при выполнении задачи закладывать время на
описательную часть. + 15-20%
Планируем автоматизировать сбор данных по связкам и исходя
из этого реагировать на изменения. (Проверка на описание
сценариев в документации)

12.

Показать airtable
Если останется время