ПДК: Документирование, или Память из бумаги Ведение рабочей тетради проекта (версия 0.4) Николай Горбунов (aka Горба) Петербургский Семинар Целеполагания. - презентация

1 ПДК: Документирование, или Память из бумаги Ведение рабочей тетради проекта (версия 0.4) Николай Горбунов (aka Горба) Петербургский Семинар Целеполагания (ПеСеЦ) «Клуб «Северное Буги», Санкт-Петербург

2 ПДК: Основной Вопрос Какова предельно допустимая концентрация (ПДК) «административной составляющей» в творческом проекте? «Инженерия без искусства может быть ужасной, но искусство без инженерии может оказаться невозможным». (Стив МакКоннелл) «Гений – человек с талантом и прилежанием человека без таланта». (Габриэль Лауб)

3 Возвращаясь к напечатанному Планирование: помнить все и успевать вовремя Постановка целей. Усилия vs. результаты План проекта, фазы и вехи. Отслеживание графика Документирование: исключить противоречия Шаблоны документов Рабочие инструкции Рабочая тетрадь проекта Коммуникации: договариваться и быть в курсе Оперативные коммуникации: что работает, а что нет Встречи: какие, как и когда Принятие решений и разрешение спорных ситуаций Модуль будет готов к 2009 году Модуль будет готов к 2010 году

4 Обратимся к классикам «Тот, у кого нет памяти, делает ее из бумаги».

5 «Нет на бумаге» = «нет в природе» Великолепный хаос идей Рабочая группа Ресурсы / инструменты Оформленный результат Документы Умный Парень Не всегда доступен, и говорит не всегда одно и то же Недостаточно конкретны, чтобы на их основе что-то сделать. Постоянно меняются

6 DWIM sucks, летим по приборам Другого способа сделать так, чтобы несколько людей узнали все необходимое и поняли это одинаково, еще не придумали Документы

7 О чем пойдет речь Как грамотно создать «бумажную память команды» Организация рабочей тетради (как представить информацию, чтобы ее потом можно было легко найти) Оформление документов (что, где и как писать, чтобы это оптимально воспринималось) Как работать с «бумажной памятью команды» Необходимая дисциплина (что необходимо делать, чтобы рабочая тетрадь не «поломалась» и постоянно была в актуальном состоянии) Документы, нарушающие эти правила, сложно читать. Поэтому их обычно никто и не читает Нарушение этих правил неизбежно влечет нарушение предыдущих. Со всеми вытекающими

8 Как структурировать информацию 1. «Снаружи» документа: структура папок/каталогов 2. «Внутри» документа: главы/параграфы/пункты И там, и тут: Уровней вложенности: не более 2-3 Элементов в категории: не более 5 Видно в файловой системе Видно в самом документе

9 Карта информации: MindManager Всегда лежит в корне хранилища Позволяет быстро и наглядно понять, что где лежит, а также куда положить новую информацию

10 Как именовать папки Критерий правильных названий: беглый взгляд позволяет сразу однозначно определить, какой документ где лежит. (Проверять лучше на случайных людях) «Служебные» папки можно помечать спецсимволами, чтобы они при сортировке по именам были всегда сверху «Родовые понятия» в начале названия – это расположит аналогичные папки рядом при сортировке по именам

11 Как именовать файлы Шифр документа. Помогает понять, к какой категории документ относится Код проекта. Помогает понять, из какого проекта этот документ Ключевые слова. Описывают то, что содержится в документе. «Родовые понятия» в начале строки – это расположит аналогичные документы рядом при сортировке по именам

12 Немного священных войн Называть ли документы по-русски? Если есть возможность не использовать русский, не используйте его – это потенциальная несовместимость Универсальный выход – транслит, но его трудно читать Применять ли длинные имена? В некоторых случаях они могут «обрезаться» системой Использовать ли в именах пробелы? Если вы не уверены, ставьте подчеркивания или дефисы

13 Устами башорга (#53501) пипец кто нибудь может мне объяснить логику? название файла: "аза кокешка хехехехехехехехехе да Дамбал.xls" содержание: налоговый отчет за третий квартал 2006г Сюда же относятся: Doc1.doc Безымянный02_вчера.gif Отчет для Лены v2.xls Письмо txt …

14 Оглавление и титульный лист Зарезервируйте первую страницу для оглавления – это значительно упрощает навигацию Можно совместить оглавление с титульным листом Глубина вложенности в оглавлении – не более 2-3 уровней Название проекта, имя документа, автор, версия

15 Наполнение и структура Размер озаглавленного блока – не более 1 страницы Число глав – желательно не более 5 Нумерация глав и параграфов значительно упрощает ссылки при обсуждении и в контроле версий Название проекта Ссылка на сайт проекта Имя файла Нумерация страниц

16 Контроль версий Зарезервируйте последнюю страницу документа для контроля версий Подробнее о контроле версий – далее Что изменялось, кем и когда С кем согласовано и когда

17 Ну и немного о содержимом Документ: «учебник» или «справочник»? Справочники: содержат конкретную информацию, непосредственно применимую на практике. Оптимизированы под быстрый поиск информации по структуре и ключевым словам. Пример – правила игры Учебники: нужны для запоминания структуры справочников. Интересные, читаются легко (но один раз ), многократное дублирование информации. Пример – описание мира игры Повторяться – полезно для запоминания, но между документами информацию дублировать нельзя!

18 Далее… Как грамотно создать «бумажную память команды» Организация рабочей тетради (как представить информацию, чтобы ее потом можно было легко найти) Оформление документов (что, где и как писать, чтобы это оптимально воспринималось) Как работать с «бумажной памятью команды» Необходимая дисциплина (что необходимо делать, чтобы рабочая тетрадь не «поломалась» и постоянно была в актуальном состоянии)

19 Централизованное хранение Чтобы это сработало, нужно, чтобы все всегда лежало в одном постоянном месте

20 Два в одном: Subversion Копии ваших файлов хранятся на сервере Сервер хранит всю историю изменений каждого файла SVN-клиент может встраиваться в обычный Windows Explorer

21 Что это дает на практике? Прозрачное и централизованное хранение Изменения больше не являются необратимыми Любой файл можно всегда «откатить» на любое число ревизий назад – например, к последней корректной версии Чтобы хранить несколько ревизий файла одновременно, не нужно назначать им разные имена

22 Необходимая самодисциплина Регулярно синхронизируйтесь с сервером Перед началом работы (скачать последние версии) Перед окончанием работы («залить» свои изменения) Закрывайте документы, закончив работу Это очень ценится коллегами Не плодите версии на пустом месте Группируйте изменения, чтобы выпускать не более 1-2 версий за сеанс редактирования (см. «бритву Оккама») Ведите контроль версий в теле документа Это обеспечит порядок в локальных копиях и распечатках

23 Контроль версий в теле документа После согласования старшая цифра увеличивается, а младшая обнуляется При создании новой версии младшая цифра увеличивается По комментариям легко восстанавливается вся история изменений документа Это последняя страница документа – чтобы сюда было легко перейти

24 Централизованное изменение Каждому документу сопоставляется один автор Ответственность автора – содержать документ в порядке и следить за своевременным его обновлением Вносит изменения в документ только его автор Все запросы на изменение документа идут автору Это правило необязательно, если хранилище поддерживает блокировку по записи

25 Фокусы с согласованием Даже если кто-то поставил на документе подпись, это не значит, что он его прочитал и понял Чем объемнее и сложнее документ, тем больше соблазн утвердить его, не читая Когда документ начнет использоваться, все, кто утвердил его «вслепую», будут мешать работе – фактически, начнется «повторное согласование» Заставляйте всех читать то, что требуется утвердить! Хороший способ уличить обманщинка – «пасхальные яйца» или умышленные ошибки в тексте документа «Предъявителю данного абзаца автор документа обязуется проставить пиво» «Игра пройдет летом 2003 года»

26 Уровни доступа к документам Внутренние документы – доступны только команде План проекта, рабочие инструкции, роли в команде, графики и протоколы совещаний, и т.п. Публичные документы – доступны всем Пакет игрока, лента новостей, календари, и т.п. Не содержат служебной информации Доступны единым блоком в отдельном месте (например, на сайте игры)

27 Итого, или Упрощенный checklist

28 Контрольные вопросы – 1 Однозначность Все хранится в одном постоянном месте Базовая структура хранилища неизменна Имена файлов и папок однозначно трактуются Содержимое файла/папки и его/ее место в хранилище можно однозначно определить по его/ее имени За каждый документ отвечает один конкретный человек Всегда доступна только одна (последняя) версия Историю изменений всегда легко проследить

29 Контрольные вопросы – 2 Легкость Оглавление всегда доступно за 1 операцию (напр. клик) Первые 1-2 уровня оглавления запоминаются за 10 секунд Нужная папка/файл в списке находится за 5 секунд Нужный абзац в документе находится за 10 секунд Завершенный по смыслу блок текста (абзац, параграф) читается без отрыва и воспринимается без подготовки за 1 раз

30 Контрольные вопросы – 3 Отчуждаемость По документу, не находящемуся в хранилище (вложение, распечатка и т.п.), всегда можно сразу понять: К чему он относится Что в нем содержится Свежая ли в нем информация Где найти дополнительную информацию К кому обращаться с вопросами, и как его найти

31 Спасибо! Соблюдая ПДК, повышаешь КПД На все вышеописанное есть готовые примеры Шаблоны документов, структура хранилища документов, рабочие инструкции и т.д. Все это, включая сами слайды, можно переписать Заходите в гости Повешен в Сеть, чтоб там висеть ЖЖ-сообщество проекта: ru_pesec

32 История изменений 0.1, 07-Дек-07 – первая ревизия 0.2, 07-Дек-07 – добавлен слайд с Маркесом 0.3, 15-Янв-08 – добавлена цитата из Габриэля Лауба + «Соблюдая ПДК, повышаешь КПД» 0.4, 6-Мар-08 – добавлен слайд «Фокусы с согласованием»