July 8, 2010

Интструмент для создания правильных гайдов

Правильные гайды должны не только содержать всю полезную информацию, но и уметь держать внимание читателей, делать им "хорошо".
Например, таким образом (ниже вытяжка из гайда по системе хранения тестов. Речь идет о полях, необходимых для заполнения, и формате их заполнения) :

a. ....
b. ....
c. Steps = шаги.
Шаги пишем в формате
1. Достать паяльник. (абзац)
2. Ударить себя по голове.
d. Expected results = результаты прохождения каждого шага
Пишем в формате
1. Паяльник в руке.(абзац)
2. Голова болит. Перестало быть скучно.
Обратите внимание, что если Шаг 1 будет занимать две строчки, то...


Слышала только положительные отзывы :)
З.Ы. Гайд внутренний, для использования внутри компании.

No comments:

Post a Comment