Size: a a a

DocOps-сообщество

2020 February 18

I

Igor in DocOps-сообщество
И таких доков много
источник

I

Igor in DocOps-сообщество
Nick Volynkin
Я знаю человека, который сразу в groff пишет. Это формат manpages, если что.
ого, он ещё жив!

В смысле есть живые люди, которые его используют
источник

DK

Daniil Kuznetsov in DocOps-сообщество
Ребят, привет. Помогите продать бизнесу идею ведения продуктовой документации. Текущее состояние - отдел тестирования пишет test case в своей табличке по фугкционалу, который они тестируют. Требования описаны в задачах в jira. Общее продуктовой понимание - раскидано по ПМ разных команд. Команд ~5. Т.е. цельной картины нет ни у кого.

Я вижу следующие проблемы -
- разрозненность знаний по проекту
- нет единого информационного окна

Так как ситуаций, в которых бы помогла документация - слишком мало, то для бизнеса это не проблемы, и он не готов тратить дополнительные ресурсы на ее ведение…
источник

EB

Elena Baskakova in DocOps-сообщество
Daniil Kuznetsov
Ребят, привет. Помогите продать бизнесу идею ведения продуктовой документации. Текущее состояние - отдел тестирования пишет test case в своей табличке по фугкционалу, который они тестируют. Требования описаны в задачах в jira. Общее продуктовой понимание - раскидано по ПМ разных команд. Команд ~5. Т.е. цельной картины нет ни у кого.

Я вижу следующие проблемы -
- разрозненность знаний по проекту
- нет единого информационного окна

Так как ситуаций, в которых бы помогла документация - слишком мало, то для бизнеса это не проблемы, и он не готов тратить дополнительные ресурсы на ее ведение…
Какие бизнес-задачи решит ведение продуктовой документации?
источник

DK

Daniil Kuznetsov in DocOps-сообщество
- все будут знать, как работает продукт - меньше отвлечения людей, у которых есть эти знания
- при возникновении вопросов - почему это работает именнено так - ответ будет в доках

это наверное единственное, что сходу приходит в голову
источник

DK

Daniil Kuznetsov in DocOps-сообщество
по идее - только экономия времени
источник

ML

Maksim Lapshin in DocOps-сообщество
Daniil Kuznetsov
Ребят, привет. Помогите продать бизнесу идею ведения продуктовой документации. Текущее состояние - отдел тестирования пишет test case в своей табличке по фугкционалу, который они тестируют. Требования описаны в задачах в jira. Общее продуктовой понимание - раскидано по ПМ разных команд. Команд ~5. Т.е. цельной картины нет ни у кого.

Я вижу следующие проблемы -
- разрозненность знаний по проекту
- нет единого информационного окна

Так как ситуаций, в которых бы помогла документация - слишком мало, то для бизнеса это не проблемы, и он не готов тратить дополнительные ресурсы на ее ведение…
поясни, что такое продуктовая документация? Для кого она?

Для внутренних сотрудников или для пользователей?
источник

D

Denis in DocOps-сообщество
Привет, чят. А какой docs-as-code стек для ведения документации сейчас самый хипстерский? И каждый хотел бы начинать новые проекты именно на нём.
источник

DK

Daniil Kuznetsov in DocOps-сообщество
Maksim Lapshin
поясни, что такое продуктовая документация? Для кого она?

Для внутренних сотрудников или для пользователей?
для внутренних
источник

DK

Daniil Kuznetsov in DocOps-сообщество
Maksim Lapshin
поясни, что такое продуктовая документация? Для кого она?

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

EB

Elena Baskakova in DocOps-сообщество
Daniil Kuznetsov
по идее - только экономия времени
Сколько часов разработчика и тестировщика, а также проджекта можно сэкономить? (ориентировочно)
источник

DK

Daniil Kuznetsov in DocOps-сообщество
Если бы у меня были описаны все механики данного функционала - то тогда вопросов бы не было. И любой (разработчик, внутренний заказчик) мог увидеть все в едином окне.
источник

DK

Daniil Kuznetsov in DocOps-сообщество
Elena Baskakova
Сколько часов разработчика и тестировщика, а также проджекта можно сэкономить? (ориентировочно)
часов 20 в месяц наверное максимум
источник

EB

Elena Baskakova in DocOps-сообщество
Daniil Kuznetsov
часов 20 в месяц наверное максимум
С каждого участника команды?
источник

DK

Daniil Kuznetsov in DocOps-сообщество
со всех 🙂
источник

DK

Daniil Kuznetsov in DocOps-сообщество
мда. похоже вывод - это не нужно
источник

EB

Elena Baskakova in DocOps-сообщество
Daniil Kuznetsov
мда. похоже вывод - это не нужно
На онбординг заложили?
источник

DK

Daniil Kuznetsov in DocOps-сообщество
не так часто приходят новые сотрудники. Раз в 2 квартала примерно - 1 человек. Текучка маленькая…
источник

NV

Nick Volynkin in DocOps-сообщество
Denis
Привет, чят. А какой docs-as-code стек для ведения документации сейчас самый хипстерский? И каждый хотел бы начинать новые проекты именно на нём.
Хипстерский, пожалуй, Gatsby, но начинать новые проекты я хочу как и раньше на Sphinx, потому что он всё равно лучше для моих задач ))
источник

NV

Nick Volynkin in DocOps-сообщество
Вообще, всё сильно зависит от задачи и требований. Какой объём доки, есть ли локализация, есть ли версии, нужно ли автогенерить часть доки из кода, какие выходные форматы нужны.
источник