З будь-якою документацією я вважаю, що спритний підхід є хорошим. Зараз там є деякі хибні уявлення, що спритний означає "взагалі немає документації чи аналізу", але це не так. Те, що я читав про спритний, говорить: "використовуй те, що працює". Я вважаю, що цей документ повинен бути довгим і детальним, співмірним із завданням.
Шаблони можуть бути корисними як контрольний список, але я б не вимагав заповнення кожного розділу для невеликих або низьких ризиків змін. Для зміни однієї лінії, можливо, вам взагалі не потрібен документ. Я ніколи не використовував шаблон для документа аналізу впливу, але регулярно маю справу з вимогами бізнесу або технічними характеристиками. Шаблон може бути занадто обмежуючим; натомість хорошим керівництвом є розгляд того, ким буде аудиторія. Якщо це менеджери, які не є технічними, зосередьтеся на виправданні бізнесу для зміни. Якщо це стосується технічних людей, надайте трохи досвіду, щоб нова людина в команді не загубилася, і дайте їм достатньо для того, щоб рухатися, якщо їм доведеться підтримати зміни. Крім того, якщо ви хочете чогось ще більш легкого і нелегкого тертя, взагалі не використовуйте документ, поставте його на вікі.
Інформація для включення:
- Короткий опис випуску
- Поясніть або покажіть приклад того, як дефект викликає збій та / або неефективність
- Включити оцінку складності
- Включайте кошторис вартості та часу на виправлення
Це гідний мінімум. В іншому дописі висвітлено деякі досить важкі речі CMMi від IBM; це чудово, якщо у вас є час і ресурси для цього (і коли ви будуєте системи для NASA, де загрожує життя людей, тоді люди краще серйозно ставляться до цього), але для невеликих команд вам, мабуть, не потрібно бути таким важким . Будьте уважні з оцінкою, як завжди. Менеджери схильні вважати, що оцінка є фактичною.
Зауважте, що в спритному підході є небезпеки. Деякі розробники вважають, що це означає, що "ніяких документів не потрібно, просто почніть злому" (що може бути нормальним у деяких ситуаціях). Крім того, інші візьмуть на себе широту задачі та просто напишуть справді хитрі документи, які не дуже допомагають (не обов’язково в більшості ситуацій). Частина проблеми полягає в тому, що писати добре вимагає певних зусиль, навичок та часу; більшості з нас не вистачає принаймні двох речей;)
Я завжди був великий у документації, тому що це доводить, що ви принаймні продумали достатньо думок, щоб кваліфікувати, як мати план. Але в старості я також зрозумів, що занадто багато документації може стати самим клопотом про технічне обслуговування, і що недостатньо людей піклується про те, щоб оновити документацію.