Синтаксис описания дефектов

Стандартный

Наткнулся в документе Administering & Using StarTeam 2008 (Borland) на интересное предложение по описанию дефектов. Предлагается использовать такой набор сокращений:

Shorthand Description
1, 2, 3,… Номер шага.
LClick Левый клик мышкой.
RClick Правый клик мышкой.
DClick Двойной клик мышкой.
[ ] Кнопка клавиатуры.
For example: [F1] for Help or [F5] for Refresh.
< > Кнопка диалогового окна.
For example: Press <OK> or <Cancel>.
> Разделитель пунктов меню.
For example: Select File > Open or Topic > Tools > Reports.
// Комментарий, не являющийся шагом выполнения сценария.
For example:
3) LClick the field.
// At this point my machine started to smoke.
EXP Ожидаемый результат.
For example:
EXP: The focus moves to the next field.
ACT Полученный результат.
For example:
ACT: The application crashes.

Описанный с помощью этих сокращений дефект, может выглядеть примерно так (пример взят из того же документа):

1. RClick the column headers in the upper pane.
2. Select Show Fields.
3. LClick Show Advanced Fields check box.
// The check box is activated.
4. LClick Show Advanced Fields check box.
// The check box is deactivated.
5. EXP: The standard fields appear in the Available Fields list box. 6. ACT: No fields appear in the Available Fields list box.

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

Реклама

Добавить комментарий

Заполните поля или щелкните по значку, чтобы оставить свой комментарий:

Логотип WordPress.com

Для комментария используется ваша учётная запись WordPress.com. Выход / Изменить )

Фотография Twitter

Для комментария используется ваша учётная запись Twitter. Выход / Изменить )

Фотография Facebook

Для комментария используется ваша учётная запись Facebook. Выход / Изменить )

Google+ photo

Для комментария используется ваша учётная запись Google+. Выход / Изменить )

Connecting to %s