Правила составления текстов сообщений
Стас Ганиев
При написании кода, зашоренный разработчик зачастую продолжает и сообщения пользователю писать на "программистском" языке. Встречаются даже сообщения со словосочетаниями в ВенгерскойНотации. Однако, не стоит забывать, что код мы пишем на одном языке, а диалог с пользователем следует строить совершенно на другом.
Вот несколько советов, которые помогут сделать интерфейс программного продукта по-настоящему дружелюбным.
1. Говори на языке пользователя. Терминология, используемая в сообщениях или в интерфейсе, должна соотноситься с пользовательским миром, т.е. это должен быть язык проблемной области пользователя, а не техническая терминология, которой привык оперировать разработчик.
Пример неправильного сообщения:
"В регистре сведений не найдены записи с требуемым отбором"
Вариант правильного сообщения:
"Для физического лица Иванов Иван Иванович не указаны сведения о паспортных данных"
2. Помоги пользователю. Сообщения об ошибках должны быть написаны на естественном языке, а не заменяться кодами ошибок. Сообщения об ошибках должны четко определять суть возникшей проблемы и предлагать ее конструктивное решение.
Пример неправильного сообщения:
"В документе есть строки, не прошедшие контроль отрицательных остатков"
Вариант правильного сообщения:
"Документ Приходная накладная 00123 от 13.08.2016, строка 17: по номенклатуре 'Шоколадка' на складе 'Основной' не достаточно свободного остатка для списания. Доступно для списания: 4, списывается по документу: 89, не хватает: 85"
3. Не кричи на пользователя. Сообщения об ошибках не должны содержать много восклицательных знаков, слов, написанных заглавными буквами, и текста раздражающих цветов (например, красный).
Пример неправильного сообщения:
"ААА!!! ОШИБКА!!! Всё плохо!"
Вариант правильного сообщения:
"Ой! Похоже у нас ошибка... Напишите нам, мы всё оперативно поправим."
4. Уважай родную речь. И конечно же, в тексте сообщения должны быть соблюдены все правила русского языка: предложение начинаем с большой буквы и заканчиваем точной, после запятой ставим пробел, и т. д. И не нужно писать всё сообщение только маленькими буквами.