Структуры руководств пользователей - пример получше

На рисунке - структуры заголовков 1 уровня руководств пользователя двухравноуровневых«подсистем»единогопрограммного комплекса.

Попросите ребенка, умеющего читать, найти десять различий в структурах руководств пользователя - пусть позабавится.

Структура руководства пользователя - пример похуже

А теперь о том, что похуже. Вот образец структуры руководства пользователя от техписа-одиночки.

Простые формальные замечания:

• Предисловие расположено после Оглавления;
• Предисловие (по сути - Введение) - заголовок 1 уровня, Заключение - заголовок 2 уровня;
• Гиперссылки не имеют никакого отношения к Навигации и существуют сами по себе;
• разделы Отличия от предыдущей версии и Что нового (в нынешней версии по сравнению с предыдущей), призванные нести единую смысловую нагрузку, не объединены и живут каждый своей жизнью;
• Учет запчастей и ремонтов явно не входит в Задачи автотранспортной компании (интересно, кто же должен заниматься учетом запчастей и ремонтов?);
• по непонятным причинам часть заголовков разделов оцифрована, большая часть - нет.

Выводы

Выводы невеселые.

Казалось бы, корпоративными стандартами серьезной компании, жестко регламентирующими как процессы, так и результаты жизнедеятельности технических писателей, предусмотрено, как минимум:

• единообразие структуры разделов хотя бы первого уровня (логическая последовательность, идентичность наименований заголовков и пр.);
• некоторое соответствие требованиям стандартов на программную документацию.

Но ничего подобного не наблюдается.

Второй образец структуры руководства пользователя, вышедший из под пера «технического писателя всех времен и народов», в принципе не подчиняется никакой логике.

С одной стороны, по мнению автора образца, «технический текст должен усыплять бдительность потенциального покупателя, создавая иллюзию, что работе с программой легко научиться. Важнейший шаг создания этой иллюзии - успокоительная узнаваемость и монотонность подачи материала».

Автор образца не знаком с п. 1 ст. 10. Закона «О защите прав потребителей» - «Изготовитель (исполнитель, продавец) обязан своевременно предоставлять потребителю необходимую и достоверную информацию о товарах (работах, услугах), обеспечивающую возможность их правильного выбора».

С другой стороны, результаты жизнедеятельности автора второго образца поражают рекламной пестротой, невладением терминологией и жутким косноязычием. Одним словом - единство и борьба противоположностей.

Формальные замечания:

• «Если навести...» - ух, каков стиль! Без старого Циреса, которого «завалил» Беня Крик, пользователю никак не обойтись;
• служил участок гиперссылкой (служил Гаврила хлебопеком);
• указатели чудесным образом «превращаются» в «персты» (далее - «пятерни», «лапы»). А брюки - в элегантные шорты;
• гиперссылки, как выясняется, бывают «выполненными» и позволяют бродить по чьим-то участкам;
• при отсутствии участка гиперссылка не работает (разумеется).

Неудобно называть автора шедевра просто «техническим писателем всех времен и народов» и т.д. Но бросать тень на автора, наносить ущерб имиджу компании, в коей он работает - уж больно неэтично.

А что скажут медики? «... указанные симптомы в течение длительного времени наблюдались лечащим врачом у больного К., 56 лет». Медицинская этика всегда была и остается на высоте.

Дабы не выходить из этических рамок, идентифицировать технических писателей всех времен и народов будем на медицинский манер - одной заглавной буквой.

Итак, приведенные в статье образцы в целом не соответствуют рекомендациям ни отечественных, ни буржуйских стандартов, ни даже рекомендациям манифеста. В таких руководствах пользователей масса важнейших сведений, необходимых пользователю для плодотворной работы с программой, попросту отсутствует.

Таким образом, процессы разработки пусть пока останутся на втором плане, а со структурой следует определяться, и как можно скорее. Вернемся к задачам.