Исправляем ошибки документирования

Всем привет!

Сложности документирования, с которыми мне приходилось сталкиваться при работе на разных проектах, описаны в посте "7 ошибок документирования".

А что вы как project manager можете сделать для  улучшения процессов связанных с документированием?

Советы и рекомендации - ниже.

Поехали!

1. Выберите правильный инструментарий

Найдите эффективную для вашего проекта связку task tracker  + content collaboration software.

От content collaboration software вам нужно:

• легкий в использовании функционал по работе с разметкой, таблицами, форматированием текста;
• поддержка версионности документов;
• возможности просмотра изменений между двумя версиями документа; 
• Спасибо, Кэп! возможности коллективной работы.

Три варианта, с которыми приходилось работать:

• Jira + Confluence
• Jira + Ms Word
• Redmine + MediaWiki

Mediawiki. “Дешево, но сердито”. Сложный функционал редактирования (особенно табличных данных) компенсирован низкой стоимостью решения.  Устанавливали различные  плагины, но все равно оказалось не очень удобно.

MS Word. Отличные возможности для редактирования контента, но отсутствие поддержки коллективной работы. Как выход - можно использовать систему контроля версий.

Confluence. Удобно управлять контентом,  есть интеграция с Jira, поддержка коллективной работы. Но стоит денег.

Самый удобный вариант  -  Jira+Confluence. Его и буду рассматривать в качестве примера в следующих пунктах.

2. Внедрите документирование в процесс разработки

• Как начать писать документацию и не забывать ее актуализировать? Сделайте написание документации обязательной частью процесса разработки! При чем не на уровне декларации “Нужно!”, а потому что процесс будет останавливаться-замедляться.

• Документация должна стать основой общения участников процесса разработки - аналитиков, разработчиков, тестировщиков и т.д.

• Документация должна быть единственным “источником правды”. Что не написано на странице в Confluence - не может рассматриваться как договоренность.

• Все ценное, что было обсуждено устно, написано в чатах, нарисовано в блокнотах должно быть обязательно зафиксировано в Confluence.

• Откажитесь от использования Jira для описания требований в тексте тикета. Вместо этого - используйте ccылку на описание требования в Confluence.

• Используйте задачи в Jira как отправную точку для grooming meeting. Выстраивайте задачи в порядке приоритета - упорядочите  обсуждения user story.

• Один из критериев готовности задачи к передаче в разработку - наличие описанного требования в Confluence.

• Следите за тем, чтобы вся значимая информация о требовании была отображена  в Confluence.

• Прививайте команде культуру бережного обращения с информацией в Confluence.

3. Использовать версионирование документов

• Описывайте только финальный вариант требования. Что, где и как должно поменяться покажет Confluence c помощью функции Compare selected versions. Это и время экономит, и количество ошибок уменьшает.

• В задаче в Jira - ссылайтесь на конкретную версию страницы в Confluence. Появится возможность работать над новой редакцией документа без влияния на тот вариант, который уже отдан в разработку.

• Альтернативный вариант - в Confluence указать ссылку на задачу Jira (используя магию Jira Issues Macro). Получаем двустороннюю трассировку “требование-задача”. Но теряем преимущество связанное с возможностью работать с разными версиями страницы.

4. Разработать стандарты

• Разработайте глоссарий. Выглядит как избыточный артефакт, но когда при обсуждениях начали называть одну из сущностей  пятью разными терминами(было и такое), то пришлось договориться о единой терминологии и зафиксировать это в виде документа.

• Разработайте шаблон структуры требований. Это ускорит написание требований и позволит избежать потери важной информации. Иногда подходит простенькая структура user story, иногда на поиск и разработку подходящих шаблонов  может уйти несколько месяцев.

• Опишите процесс управления требованиями и документацией. Да, кажется, что редко кто читает такое. Но на практике - значительно экономит время при вводе нового члена команды и обучение существующих.

• В Confluence есть шаблон требований “из коробки”. Используйте его на старте процесса внедрения документирования.

• Когда появится понимание какой шаблон нужен конкретно в вашем проекте - создавайте пользовательские шаблоны. 

Заключение

Возвращаясь к вопросу “нужна ли документация или можно обойтись без нее?”.

Для меня ответ очевиден - да, нужна. И не только для требований.

А как же тезис Working software over comprehensive documentation из agile manifesto?
Соблюдается!  Вносите в документы только “необходимую и достаточную” информацию. Не превращайте ее в "избыточную".

Улучшайте процессы, внедряйте документирование! )

7 ошибок документирования

Всем привет!

Если вы читали Agile Manifesto, то, вероятно, обратили внимание на пункт касающийся документации - “Working software over comprehensive documentation”.

Нужна или не нужна документация? Если нужна, то в каком количестве и что именно описывать? Вопросы интересные, но их обсуждение выходит за рамки данного поста. 

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

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

Для простоты описания предположим, что:

•     решение "Документации на проекте быть!" принято;
•     авторы документации будут называться “аналитиками”;
•     речь идет об описании требований  (“ТЗ”, “спецификация”, “описание фич”, “user stories”, etc.).

 

Ошибки, проблемы, нюансы

1. отсутствие понимания сложности

Писать документы начали. Что-то даже описали. Потом забросили, потому что есть более важные дела. Позже вернулись к описанию, но не всего (другие приоритеты). Часть требований - описана,  другая- описана не полностью, третья - вообще без описания.  Какие-то документы уже неактуальны. Но не понятно какие.

Пользоваться документацией невозможно, выяснять как именно что-то реализовано или должно быть реализовано приходится по-старинке (т.е. без документации). Вердикт команды - "эти waterfall-практики нам не подходят, не будем тратить время на бесполезную документацию!".

Перед началом осознанного внедрения процессов связанных с ведением документации необходимо задаться вопросом: действительно ли вы готовы ?

Готовы ли вы к тому, что на документацию будет необходимо выделять ресурс?

Мало создать документ. Его нужно поддерживать в актуальном состоянии.
И чем более нестабильные требования/бизнес/заказчик, тем больше вы будете тратить ресурс на то что бы это делать.И делать это нужно будет на регулярной основе.

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

2. необязательное документирование

"Сначала зарелизим на продакшн, а опишем потом...".

Хорошо, если "потом" таки настанет.

Но, вполне вероятно, что вместо необязательного документирования, вы будете заняты, чем-то более “актуальным, срочным, важным”.

А документация со временем так и не появляется либо окончательно теряет актуальность.

3. документация не вовремя

Выделили время, описали фичу. Приоритеты у заказчика резко изменились, и реализацию фичи отложили на неизвестный (но определенно долгий) срок.

К моменту возврата к работе над фичей документацию пришлось практически полностью переписать. В итоге - потратили в два раза больше времени на описание.

Чем ближе к agile (и, соответственно, дальше от waterfall) у вас методология выбрана для проекта, тем больше шансов что написанная "в стол" документация окажется устаревшей.

4. хаос коллективной работы

Аналитик описал требования к фиче в google docs.

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

совершенно очевидные для аналитика (т.е. в google docs так и не появились, а остались в месенджере).

Представитель заказчика немного подкорректировал и финализировал описания в google docs. Но...  уже после того аналитик перенес все описания в задачу tasktracker'а и отдал в работу на тех.команду.

В конце-концов фичу реализовали. Но с овертаймами, демотивированной командой и слегка перенервничавшим заказчиком.

Какие проблемы получили?

• одновременную работу над одним описанием, но в разных документах;
• использование нескольких альтернативных инструментов;
• дополнительные усилия на синхронизацию работы/коммуникацию/организацию доступов.

Добавить к этому списку дополнительные усложняющие обстоятельства (e.g. сжатые сроки) и головная боль вам как project manager обеспечена!

5. отсутствие версионирования

Аналитик сделал описание нового функционала.

Функционал был достаточно большой, что бы его решили деливерить в нескольких спринтах. Зарелизили в продакшн первую часть.

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

Внесли изменения в SRS по первой части, но вторую часть до продакшена не довели - заказчик поменял приоритеты.

В результате - потеряли описание работающего на продакшене функционала.

Очевидный выход - иметь несколько версий документа . Но сразу же возникают вопросы связанные с одновременной работой нескольких членов команды(аналитики, разработчики, тестировщики) с несколькими версиями одного документа - как не запутаться?

  

6. нестандартные стандарты

Один аналитик делает описания требований plain текстом. Другой - любит описывать в виде mindmap с короткими пояснениями. Третий - не признает ничего кроме блоксхем. И все трое пишут на трех разных языках. 

Есть еще описания требований и в двух других форматах, оставленные после себя аналитиками, которые уже не работают на проекте.

Ситуация, конечно-же, нереальная и встречалась мне в гораздо более приемлемом варианте.

7.  неудобный инструментарий

"Да не хочу я тут ничего описывать. Неудобно же!" -  сказал
аналитик, пытаясь создать табличку 9 на 64 в формате
wiki markup

Вместо того что бы сосредоточить усилия на содержании, неудобные средства работы с текстом могут значительно отвлекать на то что бы добиться приемлемой формы.

А это - лишний  раздражитель.

 

Заключение

При настройке процесса работы с документацией необходимо уделить внимание и таким аспектам:

•     внедрение в процесс разработки;
•     версионирование документов;
•     возможности коллективной работы;
•     наличие стандартизированной структуры описания;
•     выбор правильного инструментария.

Схему работы с документацией, которая решает указанные проблемы (и опробованную на моих проектах),  я опишу во второй части.

Технические PM'ы

Всем привет!

Есть мнение, что знания и навыки в project management'е универсальны.

 И, да, есть знакомый который перейдя из IT в агросектор прокомментировал "Да какая разница? Тут программистами управляешь,там - трактористами".

С одной стороны - это, действительно, так. С другой стороны - в IT наблюдается устойчивый спрос на project management, которые имеют технический бекграунд.

Попытаемся разобраться зачем нужны technical project manager, какие вопросы они должны закрывать и подходит ли вам эта роль.

Какие PM'ы нужны  ? 

Примеры того что могут ожидать от technical project manager как в небольших продуктовых компаниях, так и в лидерах рынка :

- ...Experience with hands-on technical delivery. Former developer is preferred. A deep understanding of digital technologies used to develop real-time web sites and mobile applications, including Java, Javascript, HTML, CSS, XML and JSON file transforms and handling...
- ...Knowledge of web architectures (AWS), CMS systems and modern online marketing tools...
- ... Development experience (open source in LAMP stack, HTML, CSS, JS). Deep Technology and Architectural Understanding...
-...A vision of future technologies and marketing trends...
-... Excellent understanding of wider industry context & trends, both technical & product

Т.е. технический бекграунд предполагается разный.

Где-то достаточно быть в курсе последних технических новинок.

Чаще в роли TechPM видят специалиста, который свернул с пути развития по технической вертикали в сторону менеджмента. Либо даже и не бросал активное участие в разработке, но приобрел некий менеджерский опыт.

Зачем опыт разработки PM'у?

Несколько реальных кейсов зачем могут понадобится PM'у технические навыки:

 1. расширение эккаунта, повышения доверия заказчика

 У компании-аутсорсера есть небольшой, но долгосрочный проект у заказчика в конкретном домене, и очень большие планы по расширению эккаунта. PM должен не только успешно выполнить текущий проект, но и постоянно предлагать заказчику варианты решения его бизнес потребностей смежных с проектными, повышая тем самым его доверие к PM'у/проекту/ компании.

2. роль СТО/техлид по совместительству

Нет возможности/необходимости для найма выделенного специалиста отвечающего за архитектуру проекта. Например, потому. что это инвестиционный проект компании /стартап, который необходимо с небольшой командой инженеров поднять "на коленке" и запустить с перспективой вырастить в направление/эккаунт. В какой-то момент развития проекта, конечно же, появятся специально обученные люди, которые будут отвечать за архитектуру. Но это будет потом и если проект "взлетит" :)

3.onsite менеджер в технической вертикали

Стремительный рост изначально небольшой out-staff команды инженеров "здесь" с руководством "там" приводит к проблемам в process & people management. Стало очевидно, что руководитель не может решить удаленно все возникающие вопросы. А так как в роли PM'а выступает СТО компании-заказчика, то и onsite PM был необходим с сильным техническим бэкргаундом, кто-то из "своей песочницы".

4. синхронизация команд

Проект с непростой организационной структурой: 4 agile команды  с общим количеством  40+ инженеров, scrum master'ов и product owner'ов.  По разработке продукта на уровне отдельных команд, вроде бы, все хорошо: фичи выпускаются, баги фиксятся, заказчики и исполнители в целом довольны. Но начали возникать существенные отличия  от команды к команде в процессах, технических стеках, инженерных практиках. Одна из задач, которую нужно решить PM'у - изменить ситуацию по образованию "зоопарка" решений и синхронизировать команды в выработке технических подходов и практик.

5. people management инженеров

TechPM понадобился в ситуации, когда инженеров нужно растить, а заниматься этим некому. HR недостает hardskills, а у лидов не хватает softskills/времени/навыков для того что бы растить команду. Development plan&performance review для разработчиков и QA? Нет, не слышали.

5. technical solution review

В команде есть solution architects/техлиды, но необходимо валидировать их технические верхнеуровневые решения. И это возлагается на PM'a. Очевидно, что при неизбежно существующей разнице в экспертизе, условный инженер доведет PM'a до границ (не) компетентности. Но чем глубже "знание предмета" у PM'a, тем дольше это будет длиться и тем больше правильных вопросов по обсуждаемой архитектуре/техническому решению PM успеет задать.

6. упрощение коммуникации с техническими специалистами в команде (в противовес позиции "Да ты же PM/бывший QA-аналитик! О чем с тобой вообще разговаривать?!");

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

С другой - встречающиеся проблемы со софсткиллами таких специалистов, смещение акцентов в менеджменте в IT с command&control в сторону servant leadership, потребность в людях пребывающих на стыке бизнес и технических интересов.

Ты - TechPM? 

Почему же не каждый, даже опытный, PM сможет осилить специфические задачи, которые возлагаются на technical project manager'а в описанных кейсах?

-  Отсутствие технического опыта. Речь об изначально нетехнических PM'ах.  Свитчеры из других отраслей, которые делали крутые проекты в аргосекторе, открывали крупнейшие в городе пивные магазины, запускали нашумевшие ТВ-проекты, могут быть хорошими управленцами, но в роли околотехнических PM'ов в IT скорее-всего не подойдут.

-  PMы с отсутствием интереса к IT-инженерии. Не всем интересно разбираться с технической составляющей проекта. Управления рисками, customer relationship management, WBS, PERT - интересно и вдохновляюще, а вот SOLID, git, SOAP API и Kibana ничего кроме уныния не вызывают. Если позиция подразумевает постоянное пребывание в контакте с инженерной проблематикой, то эта работа не для вас.

- Потеря/устаревание технических навыков. Ты - в прошлом разработчик, сейчас - PM. Занимаешься управлением проектов - сосредотачиваешься на менеджерских аспектах. И через какое-то время, подняв голову и оглянувшись вокруг за рамки "привычного" набора технологий используемых на проекте, можешь с удивлением обнаружить, что техническая картина мира IT значительно  изменилась. Появились новые языки, вышли новые фреймворки, улучшены инструменты и т.д. Поздравляю, ты - за бортом!

- Специфичность позиций. Иногда происходит подмена понятий и вместо teamlead'а (возможно с чуть более прокачанными определенными менеджерскими скиллами) ищут project manager'а. Т.е. изначально нужен разработчик, а не управленец.

Будь особенным!

Количество откликов на PM'ские вакансии согласно информации на dou на текущий момент составляет около 20 откликов на одну вакансию. Для сравнения - у технических специалистов в зависимости от профиля этот же показатель колеблется в пределах 5..10. И ситуация врядли будет кардинально меняться в сторону уменьшения.

Потому, если нужно выделиться из толпы, можно делать это в том числе и за счет развития/актуализации технических навыков.

Возможностей оставаться "в тренде" в наше время дистанционного обучения, технических блогов, многочисленных конференций и open-source проектов более чем достаточно. Дерзайте!

Daily standup meeting. И у вас получится!

Практически во всех резюме, которые довелось читать последнее время, есть информация о
agile/scrum. Что первым делом вспоминает кандидат, когда спрашиваешь об этом опыте? Практически всегда -  daily standup meetings!  А иногда - это единственное, что он может внятно рассказать о гибких методологиях.

При внедрении мной daily standup meeting в разное время и с участием разных людей возникали однотипные вопросы либо озвучивались типичные "проблемы".
Где-то  эти вопросы были продиктованы зачаточным состоянием внедрения scrum'a, а где-то - каргокультовостью оного.

Мой ТОП5
1. "Зачем собираться? Одни митинги - работать некогда."
Страх перед выступлениями, нежелание брать на себя ответственность либо показывать свое безделье "отчитываться", негативный опыт с затратными по времени митингами... Причины  у каждого могут быть разные, но митинги таки вводились, участники втягивались в процесс и такого рода вопросы отпадали сами-собой, т.к. и польза и ненапряжность митингов становится быстро очевидной.

2. "...Вчера - кодил/тестировал, сегодня - аналогично..." 
Другой вариант  этого же - слишком детализированное описание ( "..Пришел, включил, почитал, ответил, встретил, поговорил и...")
Ориентация на результат, а не на процесс - это важно :) Собственно, это и объясняется в ответ. Люди, в большинстве своем, быстро приходят к нужному формату выступления, но нет-нет да и вылазит у кого-нибудь "работу работал".

3. "А зачем стоять? Так тяжело, давайте сидя!"

Только стоя! И это работает.  На практике случалось, что члены команды сами предлагали оптимизировать дейли стендап "потому что надоело и невозможно стоять по 30-40 минут". А командная самоорганизация - это ведь тоже важно :)

4. "...А давайте соберемся на 6 минут позже, а то я чай не успеваю приготовить."
Я люблю теорию "разбитых окон", которая говорит о том, что небольшие нарушения правил, тянут за собой чуть большие нарушения, а те в свою очередь еще большие, и в конце-концов игнорирование правил полностью..
А ведь выполнение командных договоренностей - это важно :)
Потому я борюсь с  переносами, опозданиями на митинги  всеми доступными средствами.

5. "...А вот здесь я расскажу по-подробнее.." или "Я только спросить!"
Боль и печаль стендап митингов - это растягивание времени проведения за счет дискуссий и выдачи излишне детализированной информации, которая неинтересна всей части команды.
Тут палка о двух концах: с одной стороны есть четкая структура выступления "вчера-сегодня-проблемы", с другой - порой стендап это единственное удачное время-место для того что бы рассказать нечто полезное-интересное либо здесь и сейчас по-быстрому порешать. И иногда бывает эффективнее потратить небольшое время на стендапе, чем собирать отдельно этих же людей для обсуждения в другое время и в другом месте. В любом случае модератор митинга должен контролировать развитие таких ситуаций.
Я в таких случаях даю, как правило, не более 5 минут и выношу обсуждение на afterstandup meeting.

И еще с чем приходится сталкиваться на начальном этапе - выбор времени проведения митинга. Я предпочитаю утро. И этому есть несколько причин:
- при митингах вечером фокус смещается с миниконтракта на день("буду делать") на отчет ("делал"). Т.к. события прошедшего дня более близки, нежели то, что будет происходить завтра. Встречаясь же утром, команда получает некий заряд на достижение дневных целей.
В командах с которыми я работаю есть крайнее время прихода на работу, но нет такого рода ограничений по уходу. В моем случае наиболее удобно проводить митинги где-то через 30 минут после начала рабочего дня команды. Этого времени обычно достаточно, что бы подготовиться к митингу, вспомнить что было вчера и составить план на сегодня, а опаздывающим таки успеть доехать на работу :)

Понятно, что это не единственное с чем приходится столкнуться в процессе "приобщения" к правильным  standup'ам, но эффективность правильно построенных митингов высока независимо от того у вас scrum или "типа scrum". Потому - дерзайте! :)