Запись инструкции
Инструкции со следующими характеристиками легче понять и использовать. Как минимум, при записи новой инструкции, это должно быть
| Понятный и однозначный | Описание инструкции должно быть точным, ясно сформулированное, кратким, и должно задать характеристику модели (или часть модели), который может оценить инструмент проверки. Использование слова "должны", "быть", "должно", и "может" тщательно; у них есть отличные значения, которые важны для образцовых разработчиков и образцовых средств проверки (человек и автоматизированный). Читателю полезно, если автор инструкции описывает, как соответствующее состояние может быть достигнуто (например, путем выбора конкретных опций или нажатия определенной кнопки). Примеры, контрпримеры, изображения, схемы и снимки экрана также полезны и поощряются. Минимизируйте допустимые исключения к инструкции; исключения размывают инструкцию и делают ее тяжелее, чтобы применяться. Если инструкция имеет много допустимых исключений, можно пытаться покрыть слишком много характеристик одной инструкцией. (См. Минимальный, после, для некоторых решений.) |
| Легкий найти | |
| Минимальный | Инструкция должна обратиться только к одной образцовой характеристике за один раз. Инструкции должны быть атомарными. Например, вместо того, чтобы писать большую инструкцию, которая обращается к ошибочному предотвращению и удобочитаемости одновременно, сделайте две инструкции, та, которая обращается к ошибочному предотвращению и тому, которое обращается к удобочитаемости. При необходимости сделайте одну инструкцию предпосылкой другого. Кроме того, большие инструкции более вероятны, чем маленькие инструкции потребовать компромиссов для широкого принятия. Большие инструкции могут закончить тем, что были более слабыми, менее конкретными, и менее выгодными. Маленькие, фокусируемые инструкции, менее вероятно, изменятся должный пойти на компромисс и более легкое принятие. |