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

(aka Горба)
Петербургский Семинар Целеполагания (ПеСеЦ)
«Клуб «Северное Буги», Санкт-Петербург

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

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

Модуль будет готов к 2009 году

Модуль будет готов к 2010 году

не всегда одно и то же

Недостаточно конкретны, чтобы на их основе что-то сделать. Постоянно меняются

узнали все необходимое и поняли это одинаково, еще не придумали

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

Документы, нарушающие эти правила, сложно читать. Поэтому их обычно никто и не читает

Нарушение этих правил неизбежно влечет нарушение предыдущих. Со всеми вытекающими

2-3
Элементов в категории: не более 5

Видно в файловой системе

Видно в самом документе

что где лежит, а также куда положить новую информацию

какой документ где лежит. (Проверять лучше на случайных людях)

«Служебные» папки можно помечать спецсимволами, чтобы они при сортировке по именам были всегда сверху

«Родовые понятия» в начале названия – это расположит аналогичные папки рядом при сортировке по именам

проекта. Помогает понять, из какого проекта этот документ

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

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

файла: "аза кокешка хехехехехехехехехе да Дамбал.xls"
содержание: налоговый отчет за третий квартал 2006г

Сюда же относятся:
Doc1.doc
Безымянный02_вчера.gif
Отчет для Лены v2.xls
Письмо 2007-12.txt
…

упрощает навигацию
Можно совместить оглавление с титульным листом

Глубина вложенности в оглавлении – не более 2-3 уровней

Название проекта, имя документа, автор, версия

– желательно не более 5

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

Название проекта

Ссылка на сайт проекта

Имя файла

Нумерация страниц

– далее

Что изменялось, кем и когда

С кем согласовано и когда

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

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

постоянном месте

историю изменений каждого файла

SVN-клиент может встраиваться в обычный Windows Explorer

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

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

обнуляется

При создании новой версии младшая цифра увеличивается

По комментариям легко восстанавливается вся история изменений документа

Это последняя страница документа – чтобы сюда было легко перейти

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

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

«Предъявителю данного абзаца автор документа обязуется проставить пиво»
«Игра пройдет летом 2003 года»

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

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

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

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

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

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