Выгоды документирования

Как практики и сторонники подходов Agile и Lean, мы убеждены, что все нужно делать не просто так, и делать только то, что повышает эффективность. Поэтому когда дело касается документирования, многие обычные приверженцы Agile могут подумать, что эта методика означает, что документация по проекту не создана. Вместо этого она касается создания эффективных планов, и если имеется в виду документация, то она должна иметь надлежащий объем и повышать эффективность.

Мы не считаем, что нужно создавать документацию (если договор конкретно не требует определенных документов) ради документации. Хотя многие технические специалисты игнорируют мысли и упоминания о документации, мы видим в ней несколько реальных выгод. Ниже перечислены наши основные идеи относительно документации:

1. Определите, что нужно знать другим

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

2. Определите подходящий метод и стиль

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

3. Определите процесс обновлений

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

4. Рассмотрите другие выгоды и применения

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

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

Как вы используете или не используете документацию в рамках ваших проектов?