Руководство пользователя: рекомендации манифеста
«Сведения располагаются в порядке, определяемом логикой изложения. На основе сведений более общего характера излагаются сведения более частные, более конкретные, причем переход от более общего к более частному подчеркивается многоуровневой рубрикацией».
Совершенно верно. В документах описательного характера всегда следует двигаться от общего к частному. Дедукция, панимаш.
«Общая логика изложения навязывает многоуровневую рубрикацию: более общим уровням описания продукта соответствуют более крупные главы и разделы, более частным и конкретным - более мелкие, подчиненные».
Глупо оспаривать. Невзирая на то, что структура разделов руководства пользователя попросту навязывается логикой изложения.
«Соображения удобства не отменяют логики изложения, а дополняют ее. Собственно говоря, логичное, хорошо структурированное изложение хорошо усваивается и позволяет безошибочно ориентироваться в нем».
«Изложение должно быть по возможности строгим, единообразным, логически последовательным, состоящим по большей части из готовых формул...»
«Легко видеть, что из соображений удобства автор документации излагает сведения о продукте как бы в несколько обходов: сначала минимальные сведения об установке, настройке и запуске, затем описание наиболее типичных задач, затем подробный обзор всех элементов(? - прим. автора) и функций, затем специальные вопросы».
Вот она, забота о пользователе! Структура разделов руководства пользователя является определяющей при разработке пользовательских руководств.
Автор манифеста решил задачу по-своему, не ссылаясь на ГОСТ 19 и IEEE Std 1063-2001 - альтернативным способом. Важно совпадение результатов. А не как у Незнайки - сколько вариантов решения, столько и вариантов ответов.
Руководство пользователя: обосновано ли отсутствие интереса технических писателей к структуре разделов?
Соответствуют ли перечисленным выше соображениям реальные образцы пользовательских руководств?
Начнем с того, что получше. Исследуем (поверхностно) образцы творений «бригады» технических писателей, плодотворно работающих в известной российской софтверной компании.
Автор умышленно не указывает ни названия компании, ни имен (никнеймов) контактных лиц, предоставивших образцы документов. Мотивировка проста: нет желания бросить тень на светлый образ компании, с отдельными представителями которой автор знаком аж с момента основания компании. Поэтому - минимум информации (максимум конфиденциальности).
Дата добавления: 2016-04-14; просмотров: 544;