Я считаю, что в любой документации хороший подход - гибкий. Теперь есть некоторые заблуждения, что agile означает «нет документации или анализа вообще», но это не так. Вещи, которые я читал о agile, говорят: «используй то, что работает». Я полагаю, это означает, что документ должен быть длинным и детализированным, соразмерным задаче.
Шаблоны могут быть полезны в качестве контрольного списка, но я бы не потребовал заполнения каждого раздела для небольших изменений или изменений с низким уровнем риска. Для смены одной строки, возможно, вам вообще не нужен документ. Я никогда не использовал шаблон для документа анализа воздействия, но я регулярно работаю с бизнес-требованиями или техническими характеристиками. Шаблон может быть слишком ограничительным; хорошее руководство - рассмотреть, кто будет аудиторией. Если это менеджеры, которые не являются техническими, сфокусируйтесь на бизнес-обосновании изменений. Если это для технических людей, предоставьте небольшую справочную информацию, чтобы новый человек в команде не потерян и дал им достаточно, чтобы начать работу, если они должны поддержать изменения. Кроме того, если вы хотите что-то еще более легкое и без трения, не используйте документ вообще, поместите его в вики.
Информация для включения:
- Краткое описание проблемы
- Объясните или покажите пример того, как дефект вызывает сбой и / или неэффективность
- Включите оценку сложности
- Включите оценку стоимости и времени для исправления
Это достойный минимум. В другом посте рассказывалось о некоторых довольно тяжелых материалах CMMi от IBM; это замечательно, если у вас есть время и ресурсы для этого (и когда вы создаете системы для НАСА, где на карту поставлена человеческая жизнь, тогда людям лучше относиться к этому серьезно), но для небольших команд вам, вероятно, не нужно быть таким тяжелым , Будьте осторожны с оценкой, как всегда. Менеджеры склонны полагать, что оценка является реальной.
Обратите внимание, что в гибком подходе есть опасности. Некоторые разработчики считают, что это означает, что «документы не нужны, просто начните взламывать» (что может быть хорошо в некоторых ситуациях). Кроме того, другие возьмут широту, данную задаче, и просто напишут действительно дурацкие документы, которые не очень помогают (в большинстве случаев не всегда хорошо). Частично проблема заключается в том, что написание письма требует определенных усилий, навыков и времени; большинство из нас не хватает по крайней мере двух из этих вещей;)
Я всегда хорошо разбирался в документации, потому что это доказывает, что вы хотя бы задумывались над тем, чтобы претендовать на план. Но в старости я также осознал, что слишком много документации само по себе может стать проблемой обслуживания, и что недостаточно людей заботятся о том, чтобы обновлять документацию.