Size: a a a

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

2018 August 05

NV

Nick Volynkin in DocOps-сообщество
done. Немного поправил и структурировал, в остальном без изменений.
источник

ИЦ

Игорь Цупко in DocOps-сообщество
Игорь Цупко
Речь про внутркннюю доку, есличто.
Структура и читаемость - чтобы юзер мог это брать и юзать на своем уровне компетенций.
Ненагруженный, неформальный язык и минимум формализма.
Важнее наличие хотя бы паршивой, верхнеуровневой но хорошо структурированной доки (аля вот эта задача решается примерно по таким шагам, копать туды) но раньше, чем хорошо проработанной, но позже.
Важно, чтобы дока внедрялась и юзалась. Важнее всего и даже текста.
Итак, идеи?
Первое что приходит на ум - мне ревьювить все мры и разбирать с людьми.
Но у меня нет столько времени, откровенно говоря - и компетенций, да и затягивать долго не хочется правки и релизы.
источник

NV

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

NV

Nick Volynkin in DocOps-сообщество
Я бы прямо с каждым сотрудником несколько раз прошёл этот путь, чтобы убедиться, что мы одинаково понимаем цели.
источник

NV

Nick Volynkin in DocOps-сообщество
— сделать шаблоны разных документов: функциональная и техническая спецификация, описание архитектуры, фоллоуап после обсуждения и т.п.
источник

NV

Nick Volynkin in DocOps-сообщество
шаблоны ещё и ускоряют сильно написание. Не надо начинать с чистого листа — это трудно.
источник

NV

Nick Volynkin in DocOps-сообщество
И помогают не забыть о важных аспектах.
источник

NV

Nick Volynkin in DocOps-сообщество
Про шаблоны пара постов в бэклоге лежит у меня )))
источник

ИЦ

Игорь Цупко in DocOps-сообщество
Nick Volynkin
— работать с целеполаганием. Каждый раз думать, для кого документ пишется, какую задачу читателя он решит, на каком ребре графа коммуникации находится.
И как только появляется документ под новую цель - люди фигачат бездумно, даже не задаваясь вопросом, что что-то не так
источник

NV

Nick Volynkin in DocOps-сообщество
Может, ввести шаг «подумай, про что документ»?
источник

ИЦ

Игорь Цупко in DocOps-сообщество
Nick Volynkin
Я бы прямо с каждым сотрудником несколько раз прошёл этот путь, чтобы убедиться, что мы одинаково понимаем цели.
А как бы ты это понял?
источник

ИЦ

Игорь Цупко in DocOps-сообщество
Nick Volynkin
— сделать шаблоны разных документов: функциональная и техническая спецификация, описание архитектуры, фоллоуап после обсуждения и т.п.
Увы, шаблона два:
- гайд - пять-десять статей по теме, которые должны помочь решить проблемы определенного типа. Не шаблонизируется.
- пример. Кусок живого кода. Не шаблонизируется.
В обоих кейсах ппц как важно "а что включить в доку, а что не так важно? Как структурировать?"
источник

NV

Nick Volynkin in DocOps-сообщество
Приветствую всех, кто зашёл в чат. Если что, тут ещё канал есть: @docops.
источник

NV

Nick Volynkin in DocOps-сообщество
Игорь, а есть уже хорошие примеры доков? Можно из них извлечь критерии качества?
источник

СЕ

Сергей Егоров in DocOps-сообщество
Игорь Цупко
Коллеги, разрешите ворваться к вам.
Проблема: есть пара-тройка человек, которые пополняют внутреннюю базу знаний. И каждый тянет одеяло на себя, не могут договориться о том как структурировать доки, как делать меню, навигацию и прочее.
Как договориться?
В программировании для этого есть фреймворки и паттерны. А с русским языком как быть? ) Он ж не компилируется и автотесты не напишешь.
Мое мнение - основная ошибка в том что в программировании данный вопрос решается фреймворками и паттернами, здесь достаточно холеваров и т.п.
В первую очередь нужно научиться договариваться и достигать одни цели, т.е. моя мысль такова что поставить глобальные цели, которые будут общими и их примут все трое. Далее сделать разбивку целей в глубину так чтобы они определили подходы и приоритеты вместо вкусовщины. Если же окажется что на каком-то уровне детализации - выбор решения не роляет, то может и не стоит спорить и унифицировать именно на этом уровне.
источник

ИЦ

Игорь Цупко in DocOps-сообщество
Сергей Егоров
Мое мнение - основная ошибка в том что в программировании данный вопрос решается фреймворками и паттернами, здесь достаточно холеваров и т.п.
В первую очередь нужно научиться договариваться и достигать одни цели, т.е. моя мысль такова что поставить глобальные цели, которые будут общими и их примут все трое. Далее сделать разбивку целей в глубину так чтобы они определили подходы и приоритеты вместо вкусовщины. Если же окажется что на каком-то уровне детализации - выбор решения не роляет, то может и не стоит спорить и унифицировать именно на этом уровне.
Код не заработает сразу, если в нем синтаксические/структурные ошибки.есть немедленная обратная связь для джуна.
В случае доки "не заработает"=не зайдет пользователям. Фидбэк через недели. Слишком поздно.
источник

ИЦ

Игорь Цупко in DocOps-сообщество
Nick Volynkin
Игорь, а есть уже хорошие примеры доков? Можно из них извлечь критерии качества?
Эту мысль я давно думаю, но пока выборка маловата - сложно экстраполировать.
источник

NV

Nick Volynkin in DocOps-сообщество
У вас пользователи — ваши сотрудники? Можно ли дать доку почитать другому джуну или просто кому-то, кто мало знаком с темой?
источник

СЕ

Сергей Егоров in DocOps-сообщество
Проблема в точности изложения материала, или в форме представления (структуре)?
Имхо, сейчас идёт путаница теплого с мягким.
источник

NV

Nick Volynkin in DocOps-сообщество
К тому же по твоему собственному DoD, сделать доку — значит внедрить её, то есть люди уже должны ей пользоваться.
источник