Довідка і вікно про програму

Якщо ви подумали, що я прихильник музики в стилі "сатанинський хеві-Метлі", то крупно помилилися - просто, на мій погляд, вивчення текстів англомовної рок-музики (а іноді і поп-музики), для людини, яка не сприймає на слух швидку англійську мову, дуже цікаве і корисне заняття. Але про це якось іншим разом - тут ми поговоримо про те, як же "підняти з землі" розум стомленого користувача комп'ютерних програм?

І тим не менше довідка повинна бути в будь-якому випадку. І я вже писав про те, що для програміста складання довідки - один з найважливіших етапів створення програми, це потрібно йому самому не в меншій мірі, ніж користувачу. Коли ви пишете довідку, ви проходите всю логіку роботи з програмою заново, причому з точки зору стороннього, і тут можуть виявлятися такі "ляпи" і недоробки, які в іншому випадку можуть виникнути тільки після довготривалої експлуатації. Я впевнений, що якби програмісти Microsoft, перш ніж вводити поняття "мови", про що ми довго говорили в главі 8, спробували письмово б викласти своє бачення цієї проблеми в розрахунку на користувача системи, то такій страшній пуганіци б не виникло.

Як і довідка по Windows в цілому, так і "Майстер підказок" особливо, засновані на хибному підході, який ми умовно назвемо "парадигма FAQ" - коли укладачі намагаються перебрати максимум можливих питань, які, в їхньому уявленні, повинні виникати у користувача, і відповідають на них. І не намагайтеся йти цим шляхом - навіть для найпростіших програм ви ніколи не зможете уявити все різноманіття життєвих ситуацій. Тут доречно провести паралель з кримінальним кодексом - є закони, а є їх тлумачення (FAQ), і тлумачення складаються в більшості випадків апостеріорі, т. Е. Є збірник відповідей на конкретні питання, які виникають в конкретних життєвих ситуаціях, і в багато разів за обсягом перевищують сам кодекс. Якби законодавці при складанні кодексів спробували б заздалегідь передбачити всі ситуації - у них все одно нічого б не вийшло. А адже саме гак надходять укладачі довідки Windows. Якщо ви хочете допомогти користувачам - складайте, звичайно, збірники "Часті запитання", але тільки на додаток до основної довідці, а не як заміну її.

>. Як шукати файли?

Щоб знайти файл, клацніть кнопку "Пошук", після чого у вікні "Пошук фатов" вкажіть папку ...

Що саме хоче користувач - для вас таємниця за сімома печатками, може у нього в житті такого питання не виникало - "як шукати файли?". Правильно буде написати так:

I. Кнопка "Пошук".

При натисканні лівою кнопкою миші на кнопці "Пошук" відкриється вікно з заголовком "Пошук файлів", в якому ви побачите перелік папок. При вказівці однієї з папок ...

Якщо все ж без явної вказівки завдання користувача не обійтися, то бажано хоча б починати його з припущення: "Якщо ви хочете знайти фаю. То ...", тут неявно мається на увазі, що завдань може бути багато різних, але от якщо ви хочете саме це, то тоді будьте люб'язні, вже не полінуйтеся клацнути таку-то кнопочку. Не смійтеся - я абсолютно серйозний, тому що написання програм є одна з різновидів надання сервісних послуг, і не може не підкорятися загальним законам в цій області, перший з яких відомий: "покупець завжди правий" (шкода тільки що так звані "маркетологи" зазвичай погано ці закони засвоюють).

Нотатки на полях

Але досить політінформацій, повернемося до довідки. У зазначеному раніше стилі слід давати і додаткові пояснення, що станеться, якщо користувач зробить те-то і те-то. Наприклад: "якщо ви натиснете клавішу при відкритому вікні "Пошук файлів", то це викличе перезапуск комп'ютера з повним руйнуванням файлової структури жорсткого диска ". Обов'язково давати подібні пояснення тоді, коли є якісь обмеження, особливо неочевидні - наприклад, як для налаштувань нашого перемикача розкладки слід згадати, що буквених клавіш з атрибутом "розширена" просто не існує в природі.

Найбільшою помилкою також майже всіх без винятку укладачів довідки є те, що вони не формулюють завдання в цілому: що взагалі робить програма, для чого вона призначена? Іноді це дуже важко з'ясувати навіть після установки програми, не кажучи вже про те, щоб вивести коротку довідку на цю тему перед установкою. Про поясненні використовуваних термінів я вже й не кажу: в улюбленій мною програмі The Bat! є пункт під назвою (в російській варіанті) Стиснути все папки. Спробуйте з ходу збагнути, що мається на увазі (насправді-очищення від сміття), - і в довідці, яка є найслабшим місцем цієї чудової програми, з'ясувати щось практично неможливо.

Але залишимо цей важкий питання - з приводу правильного вживання слів слід написати окрему і зовсім іекомпьютерную книгу, і цей момент ще не найстрашніше: можна написати довідку на кострубато жаргоні і з орфографічними помилками, але так. що буде все зрозуміло н дохідливо викладено. А можна бути блискучим стилістом, але написати каламутний текст, який доведеться перечитувати кілька разів, щоб тільки спробувати зрозуміти, "про що вони тугий?".

заважає з ними ознакоміться- хоча і необов'язково, звичайно, діяти строго але букві цих, іноді надуманих, правил.

Питання про те, чи створювати довідку в стандартному стилі Windows Help, я залишаю на розсуд читачів. Формат цей, на мій смак, зроблений вкрай огидно, а гіперпосилання, що довгий час були серйозним аргументом на його користь, тепер можна вставляти навіть в документи Word. Єдиним серйозним аргументом на користь цього застарілого формату є його тісна інтеграція з програмою, коли будь-якого компонента можна надати свою власну довідку, не виходячи за рамки єдиної структури. Але використання контекстної довідки, на мій погляд, взагалі річ порочна, типове породження згаданої "парадигми FAQ", передбачити саме те питання, яке у користувача в даний момент виникне, практично неможливо. Якщо ви відмітили, я навіть ніколи не користуюся спливаючі підказки (hint) - в більшості випадків вони тільки захаращують поле зору і відволікають користувача. Єдиний, на мій смак, правильний спосіб використання спливаючих підказок - демонструвати доступні гарячі клавіші, і треба ж так статися, що коли така підказка дійсно потрібна була по ходу нашої розповіді (в главі 14 для пункту меню) - то її якраз створити виявилося не можна ( не взагалі не можна, а можна в зручній для користувача формі-для пунктів меню підказки можна тільки виводити в який-небудь компонент через обробку події onHint).

Куди більш зручною і для розробника і для користувача є сучасна довідка в форматі HTML (і ще більш просунутих форматах, таких як СНМ). Є багато спеціальних інструментів, які дозволяють створювати такі довідки, і ми тут не будемо їх розглядати - для цього є спеціальна література. Ми, як люди сермяжное, розглянемо коротко лише два питання - як можна створити і відобразити без зайвих клопотів коротку довідку без використання спеціальних засобів.

Схожі статті