Бросок через стену

Дизайн и разработка
19 августа 2013

Свидетельство из жизни: Код готов (без тестирования, без документации).

Вводная информация

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

Любое человеческое знание по своей природе имеет личный характер. Даже самые знаменитые учёные обладают интуицией, которая движет их открытиями и поиском новых данных. Понимание этих личных мыслей важно для понимания всей их работы.

Проблема анти-паттерна

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

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

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

Решение для улучшения

Есть несколько способов, чтобы техническая документация была понята и использована так, как надо. Один из них — донести знание с помощью тренинга. Когда будут сформулированы новые стратегии и указания, необходимо организовать соответствующую передачу информации для её распространения и обсудить её целесообразность.

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

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

Оригинал статьи: Source Making (sourcemaking.com)
Похожие статьи
Комментарии (0)