Многие из вас, наверняка, знают о таком понятии, как тестирование документации. А тот кто не знает, лекго может узнать . Правда, в тех статьях, которые вы можете найти , речь обычно идет о тестировании документации используемой в процессе разработки ПО (ТЗ, спеки или как вы их там еще называете). Но в таких статьях очень редко вспоминают о тестировании пользовательской документации. Странно, почему? Лично мне кажется, что глючная документация способна принести не меньше проблем (читай — поводов для разрушения головного мозга вашей тех. поддержке), чем глючное ПО. Честно, я много раз встречал мануалы, после прочтения которых, первое что хочется сделать — позвонить разработчику. Вот и сегодня, мне в руки попался весьма забавный документ. Руки так и чешутся, взять и позвонить. Ну да ладно, у людей и так много работы, я лучше спрошу у общественности ;)
Вобщем, такое дело...
По долгу службы мне (и не только мне) приходится пользоваться KVM'ом. Все бы ничего, да только модель KVM'ов, которую нам закупили имеет привычку радостно попискивать при переключении с одной машины на другую. Ну мне, как бы, пофигу, ибо я практически целый день сижу в наушниках, но есть люди, которым не очень нравятся «вот эти сидящие напротив» и попискивающие каждую минуту. Короче, чтобы предотвратить вандализм и не дать людям взяться за отвертки, было решено все же почитать мануал и отключить динамик более гуманным методом. К сожалению, способа отключить его полностью мы так и не нашли, но зато нашли, нечто более интересное.
Вот оно — интересное (тысяча извинений за качество фото, телефон, как-никак):
Теперь мы живем в неведении — то ли действительно на клавиатуре где-то спряталась клавиша Any Key, то ли пробел теперь не входит в множество под названием «любая клавиша»… нипанятна...
Ну и как положено, что-то похожее на мораль:
Не забывайте, что пользователи тоже люди :) и они хотят не только видеть хорошо работающую программу, но и понятную документацию к ней.
Лично я, когда мне доводилось писать пользовательскую документацию (да, да и такое бывает :)), всегда пытался всучить ее кому-нибудь «для посмотреть». Ну а нынче, когда у нас есть технический писатель (обожекакярад!), в нашем ишью трекере после статуса Active — Documentation, значится статус In Test — Documentation.
Ну судя по всему, действительно, не очень активно ее тестируют. И, порой, зря. Как по мне, то хорошая документация поможет избежать многих проблем при поддержке продукта.
У нас идет разделение на документацию для админа и пользовательскую документацию. Тестируем вместе с ПО по всем правилам тестирования ПО (отдельная задача, дефекты, статусы). Пытаемся всегда тщательно проверять. Но когда времени мало, проходит и «пробежка» по тексту с выделением явных косяков.
О полезности такого подхода трудно судить, т.к. на вопросы заказчика отвечает сапорт, но полагаю, что многое становится понятнее после прочтения. Зато сапорт хорошо вчитывается перед рассылкой подсистемы. :)
Нормальная фраза в мануале. Пробел входит в множество под названием «любая клавиша». Но пользовательское действие «нажатие любой клавиши» — это строгая альтернатива действию «нажатие пробела» (даже если результат этих альтернативных действий совпадёт), имхо.
Пробел входит в множество под названием «любая клавиша». Но пользовательское действие «нажатие любой клавиши» — это строгая альтернатива действию «нажатие пробела»
Долго медитировал над этой мыслью. Так и не уловил логику :)
1. Когда я тычу любую клавишу — я не думаю(уделяю внимание) какую клавишу тыкать.
Когда я тычу пробел — я думаю(уделяю внимание).
«Думаю» строгая альтернатива «не думаю».
2. Есть люди, которые не любят генерализаций. Mindset у них такой. Им надо непременно сказать какую конкретно клавишу тыкать, «сколько точно вешать в граммах». Для них грамотный мануал предложил альтернативу — ну нажмите пробел, раз вам эникей психологически не подходит.
3. Кстати, я тоже люблю в качестве эникея использовать именно пробел. Почему? Легко попасть + довольно безопасная клавиша. Если Enter (тоже из множества «any key») может запустить что-нибудь непоправимое, то пробел максимум сменит выбор крестиком пункта в псевдографике. Хорошая практика.
4. Вопрос на засыпку. Кто вообще сказал, что OR в мануале это «либо», а не «и/или» )
Ваше предположение очень правдоподобно и, скорее всего, так оно и есть. Жители поднебесной любят понимать все слишком буквально, особенно если дело касается других языков.
У меня, правда, есть несколько другая версия. Такая инструкция — своеобразная защита от блондинок, которые не могут найти на клавиатуре «эникей». Только я, если честно, блондинок-секретарш юзающих КВМы пока не встречал. :)
Комментарии (14)
RSS свернуть / развернутьretverd
Vader
retverd
LeshaL
З.Ы. Тему обязательно почитаю позже.
Vader
alsedi
Vader
О полезности такого подхода трудно судить, т.к. на вопросы заказчика отвечает сапорт, но полагаю, что многое становится понятнее после прочтения. Зато сапорт хорошо вчитывается перед рассылкой подсистемы. :)
kmmrb
korziner
Долго медитировал над этой мыслью. Так и не уловил логику :)
barancev
Когда я тычу пробел — я думаю(уделяю внимание).
«Думаю» строгая альтернатива «не думаю».
2. Есть люди, которые не любят генерализаций. Mindset у них такой. Им надо непременно сказать какую конкретно клавишу тыкать, «сколько точно вешать в граммах». Для них грамотный мануал предложил альтернативу — ну нажмите пробел, раз вам эникей психологически не подходит.
3. Кстати, я тоже люблю в качестве эникея использовать именно пробел. Почему? Легко попасть + довольно безопасная клавиша. Если Enter (тоже из множества «any key») может запустить что-нибудь непоправимое, то пробел максимум сменит выбор крестиком пункта в псевдографике. Хорошая практика.
4. Вопрос на засыпку. Кто вообще сказал, что OR в мануале это «либо», а не «и/или» )
korziner
0_о
Vader
barancev
У меня, правда, есть несколько другая версия. Такая инструкция — своеобразная защита от блондинок, которые не могут найти на клавиатуре «эникей». Только я, если честно, блондинок-секретарш юзающих КВМы пока не встречал. :)
Vader
Только зарегистрированные и авторизованные пользователи могут оставлять комментарии.