ПДК: Документирование, или Память из бумаги презентация

ПДК: Документирование, или Память из бумаги Ведение рабочей тетради проекта (версия 0.4)

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

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

Обратимся к классикам

«Нет на бумаге» = «нет в природе»

DWIM sucks, летим по приборам

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

Как структурировать информацию

Карта информации: MindManager

Как именовать папки

Как именовать файлы

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

Устами башорга (#53501) <dk> пипец <dk> кто нибудь может мне объяснить логику? <dk> название файла: "аза кокешка хехехехехехехехехе да Дамбал.xls" <dk> содержание: налоговый отчет за третий квартал 2006г

Оглавление и титульный лист Зарезервируйте первую страницу для оглавления – это значительно упрощает навигацию Можно совместить оглавление с титульным листом

Наполнение и структура

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

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

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

Централизованное хранение

Два в одном: Subversion

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

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

Контроль версий в теле документа

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

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

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

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

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

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

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

Спасибо!

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