суббота, 3 сентября 2011 г.

Советы по наименованию вариантов использования

Оригинал статьи: How to Write Good Use Case Names – 7 Tips

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

Цели именования вариантов использования
При определении имени или названия для варианта использования перед вами стоят следующие цели:

  • Четко указать цель пользователя, представленную вариантом использования
  • Избегать описания аспектов проектирования и реализации
  • Сделать так, чтобы люди захотели читать это вариант использования, а не испытовали страх перед чтением его
  • Предусмотреть возможность изменения варианта использования в новых релизах
  • Определить границы проекта
  • Писать согласовано
Типичные ошибки вариантов использования
Ранее была написана пар статей, в которых нами были определены 10 ошибок вариантов использования. Вот они:
  • Несогласованность
  • Некорректность
  • Неверные приоритеты
  • Намеки реализации
  • Разрыв прослеживаемости
  • Непредвиденные ошибочные условия
  • Пропуск реакции (отклика) системы
  • Неопределенные действующие лица
  • Непрактичные варианты использования
  • Варианты использования за рамками области определения
Правильные имена для вариантов использования помогут избежать ошибок в согласованности, намеков на реализацию, проблем с управлением границ проекта, прослеживаемости. Они также должны способствовать тому, чтобы люди хотели их прочитать. Если название варианта использования будет как заголовок статьи в журнале - вы захотите его прочитать или будете стремиться избежать этого?

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

Советы по написания правильных названия вариантов использования

Вот несколько наилучших рекомендации, собранных по всему Интернету:

  • Правильные названия вариантов использования отражают цель пользователя. Правильное название варианта использования отражает цель пользователя или внешней системы. Название типа "Обработать счета-фактуры" не говорит нам, что нужно сделать - собрать, организовать, произвести аудит или выполнить какие-то другие действия над документами. Более понятным было бы название "Собрать просроченные платежи от клиентов". Целью в данном примере будет сбор платежей от клиентов-должников. Второй вариант названия существенно лучше передает то, что нужно сделать пользователю в ходе выполнения этого варианта использования.
  • Правильные имена вариантов использования должны быть по возможности максимально краткими. Некоторые полагают, что название не должно содержать более 5 слов, а лучше не более двух. Однако существует масса примеров, когда применение ограничение на количество слов в названии непрактично. В предыдущем примере: "Собрать просроченные платежи от клиентов" - какие слова вы бы удалил без потери смысла?
  • Правильные имена вариантов использования используют информативные глаголы. Обычно люди считаю, что мы должны отдавать предпочтение сильным глаголам, а не слабым. Это типичные рекомендации в отношении письма. Однако при написании вариантов использования мы можем быть более конкретными. Бессмысленным будет тот глагол, который указывая на действие, не определяет его достаточно подробно и понятно.  "Обработать заказ" может быть улучшено, используя более информативный глагол. "Проверить заказанные товары" делает понятным, чего пытается достичь пользователь в этом варианте использования.
Приведу перевод следующих двух рекомендаций. Следует заметить, что в реальной практике русского языка эти рекомендации вряд ли применимы.
  • Правильные имена вариантов использования используют действительный залог. Призыв к действию является признаком хорошего письма. Использование активного залога вдохновляет больше, чем действие в страдательном. Сравните: "Рассчитай рентабельность" и "Рентабельность рассчитывается".
  • Правильные имена вариантов использования используют настоящее время. "Создай новую учетную запись" в настоящем времени. "Новая учетная запись была создана" в прошедшем. Настоящее время подразумевает то, что пользователь пытается сделать, а не то, что уже было сделано. 
Вместо них я ввожу другое правило:
  • Правильные имена вариантов использования начинаются с глагола в неопределенной форме или с отглагольного существительного. Сравните: "Записаться на курс" или "Запись на курс". Использование той или иной формы, дело предпочтений. Однако использование неопределенной формы дает большей определенности, чем отглагольное существительное. В моем примере "Запись" можно воспринять как сущность, а не действие. Кроме того "Записаться на курс" легко выводится из такой фразы: "Студент обращается к системе, чтобы записаться на курс" или "Студент желает (хочет) записаться на курс".
  • Правильные имена вариантов использования не содержат действующих лиц. Некоторые люди предпочитают включать имя действующего лица в вариант использования, поскольку это является более конкретным. Однако следует учесть возможность изменения действующего лица для одного и того же варианта использования в разных релизах. Например, "Ранжировать сотрудников по производительности". В первом релизе, эта функциональность определена для супервизиров, которые могут ранжировать своих штатных сотрудников. Во втором релизе, добавлена возможность делать это для менеджеров, которые могут управлять несколькими супервизорами. Предпочтительно иметь две версии одного и того же варианта использования "Ранжировать сотрудников по производительности", чем два варианта использования "Ранжировать прямых/косвенных сотрудников по производительности". 
  • Правильные имена вариантов использования являются согласованными. Следует всегда применять один и тот же набор правил для всех наших названий вариантов использования. Непоследовательное применение правил будет создавать ощущение диссонанса для читателей. Согласованные названия более удобны для читателей, и обеспечивают чувство сплоченности для всего проекта
Другие ссылки:
Правильные названия вариантов использования не будут занимать много усилий, как только  вы приобретете навык писать их в согласованном стиле, следуя предложенным выше рекомендациям. Правильные названия дают ряд преимуществ будущем при просматривании и чтении вариантов использования. Правильные имена - короткие, ясные и стильные. Они побуждают нас прочитать вариант использования, помогают нам понять и помнить какова цель пользователя.

Комментариев нет:

Отправить комментарий