Как создать инструкцию по работе с программой

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

Текстовые инструкции

Руководство пользователя должно отвечать на три основных вопроса: «Что?», «Зачем?», «Почему?», то есть раскрывать суть, объяснять специфику и возможные причины. Поданная информация должна показать все возможности товара и таким образом донести разнообразие функций пользователю. Инструкция является важным показателем отношения к клиенту.

Правила по тексту

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

Правила по форме

Notion — Быстрый курс

• Пиктограмма в основном тексте отрицательно влияет на читабельность.
• Если трудно описать, нарисуйте.
• Рисуете – опустите мелкие детали.
• Не увлекайтесь иллюстрациями.
• Не гонитесь за эстетической красотой рисунка, он должен быть максимально понятен.
• Делайте интервал между абзацами. Так лучше воспринимается текст.
• Используйте крупный хорошо читаемый шрифт.
• Не размещайте разные темы на одной странице.
• Заголовки должны быть четко отделены от основного текста.
• Оглавление и номера страниц – обязательная часть хорошей инструкции.

Советы

• Ссылаться на другие разделы инструкции можно, но с указанием и раздела, и страницы.
• Колонтитулы в руководстве пользователя должны быть информативными и полезными.
• Если в результате получается слишком большое пособие, лучше разделить его. Например, введение в эксплуатацию, руководство и решения для возможных проблем.
• Обновление продукта должно повлечь за собой обновление инструкций к нему.
• Нужна инструкция, но нет навыков? Лучше обратиться за выполнением к специалисту. На сайтах для фрилансеров их достаточно.

Видео-инструкции

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

Основные правила

• Сценарий нужен в любом случае, и его автором должен быть профессионал.
• В кадре должна быть именно та модель продукта, о которой идет речь. Любое несоответствие вызывает недоумение.
• Начитка не должна быть слишком быстрой или медленной. Примерно 150 слов в минуту.
• Каждое действие на экране должно сопровождаться разъяснением.
• Если видео посвящено каким-либо проблемам, начните непосредственно с них, а затем переходите к решению.
• Приятна должна быть не только картинка, но и звук. Постарайтесь, чтобы голос звучал профессионально и четко. Грамотная речь тоже важна.
• Внешний вид должен соответствовать. Если речь идет, например, о ремонте автомобиля, целесообразно одеться в рабочий комбинезон.

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

Основы работы в Blender за 10 минут.

Скринкастинг: запись действий с рабочего стола

Если стоит задача объяснить специфику использования программного обеспечения, лучше использовать программы записи действий с компьютера. Такую возможность рассмотрим на примере одной из программ – Movavi Screen Capture Studio для Windows или Mac. Одна из ее функций – запись всех ваших действий с экрана.

Алгоритм работы

1. Скачать программу и запустить дистрибутив.
2. Установить настройки записи: захват видео и эффекты.
3. Выбрать параметры звука: динамики компьютера или ваши комментарии посредством микрофона.
4. Уточните область, которая должна быть отражена на видео.
5. Нажмите кнопку REC для записи, при необходимости используйте кнопки Пауза или Стоп.
6. Сохраните видео, предварительно конвертировав в нужный формат.
7. Распространите ролик на YouTube или Vimeo через эту же программу с помощью кнопки Share Online.

По такому же принципу работает программа Camtasia Studio и Camtasia for Mac. Происходит захватывание видео с экрана по установленным вами параметрам. Здесь также можно записать звук с микрофона или динамиков, а также разместить видеоролик с веб-камеры с возможностью последующего редактирования.

Аналоги

Screencast-O-Matic. Бесплатна и позволяет опубликовать видео длительностью до 15 минут на бесплатном хостинге. На готовом видео будет водяной знак компании.

UvScreenCamera. Существует платная и бесплатная версии. В наличии многофункциональный редактор. Платная версия имеет пробный период в 14 дней. Бесплатная версия ограничивает количество форматов и добавление аннотаций.

Fraps. Поддерживает почти все видеокарты. Позволяет измерять FPS в играх, создавать скриншоты одной клавишей и записывать видео в реальном времени. Бесплатная версия позволяет записывать всего 30 секунд, накладывает водяные знаки и создает скриншоты исключительно в растровом формате. Стоимость платной версии – 29.95$.

Скриншоты

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

Программа позволяет

• Делать скриншоты и комментировать их
• Добавлять в руководство видео
• Прописывать теги по каждому отдельному уроку
• Конвертировать в форматы HTML, PDF и Word-файлы
• Использовать несколько шаблонов
• Форматировать текст и т.п.

Как правило, интерфейс этих программ интуитивно понятен, и особых навыков для работы с ними не потребуется.

Аналоги

Screenpresso. Позволяет делать снимок целого экрана или его части, отправлять их по почте и редактировать широким набором инструментов. Есть возможность добавить эффекты, совместить несколько скриншотов в один.

Lightshot. Снимок экрана в 2 клика, возможность публикации в Интернет и получения ссылки. Редактор, по утверждению разработчика, не уступает Photoshop. Работает под Windows и Mac.

Формат PDF

Если для создания руководства был выбран формат PDF, стоит обратить внимание на наличие специальных программ для работы именно с такими файлами. Так, например, программа Nitro PDF Professional позволяет из более 300 типов файлов создать один, в PDF-формате.

Возможности

• пакетная обработка файлов;
• конвертация почти из любого формата в PDF;
• экспорт из PowerPoint, Microsoft Word или Excel;
• возможность шифрования готовых файлов;
• редактирование изображений и текста;
• добавление закладок, ссылок, марок, водяных знаков и колонтитулов;
• восстановление, сжатие и оптимизация PDF-документа.

Аналоги

Solid Converter PDF. В наличии недавно вышедшая русская версия. Широкий спектр инструментов и форматов.

Soda PDF Professional + OCR Edition. Встроены профессиональные формы и шаблоны, поддержка более 300 форматов, функция распознавания текста. Не так давно появилась версия с русским интерфейсом.

Инфографика

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

Претендовать на индивидуальность не приходится.

Составляющие хорошей инфографики

• Легкий стиль. Если созданием инфографики занимается дизайнер, он наверняка знает, какие элементы будут оправданы. Стоит отказаться от сложных изображений и разнообразных шрифтов.
• Актуальность. Нужно изучить, что именно у вашей аудитории вызывает интерес или вопросы. Используя цифры, убедитесь в их достоверности.
• Информативность. Несмотря на свою лаконичную форму, инфографика должна нести полезную информацию.
• Компактность. Не нужно делать инфографику слишком длинной. Файл должен быстро подгружаться на странице.

FAQ

FAQ или ЧаВо – это собрание ответов на вопросы, которые часто задаются пользователем. Тематика сборника всегда соответствует специфике ресурса. Основная цель этого раздела – дать ответ еще до того как возникнет вопрос. Это значительно упрощает работу администрации ресурса и делает его удобнее для пользователя. Существуют также отдельные сайты с FAQ по разным темам (например, Internet FAQ Archives).

Что важно?

• Начинать писать FAQ нужно с элементарного: вспомнить, что чаще всего спрашивают у онлайн-консультанта или менеджера ваши посетители. Когда приблизительный список вопросов готов, можете приступать к написанию ответов на них.
• Просмотрите свой сайт в очередной раз. Подумайте о том, что вам было бы не понятно или интересно. Отметьте для себя эти пункты.
• Нужно понимать, что раздел ответов на вопросы должен удовлетворить необходимости в информации в тот момент, когда вы или ваши представители не могут ответить лично. Например, ночью, в праздники или на выходных.
• FAQ – это своеобразный показатель заботы владельца ресурса или компании о своем клиенте. Чем детальнее вы «разжевали», тем приятнее с вами работать.
• Несмотря на справочный характер этого раздела, он должен вызывать интерес.

Выводы

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

Источник: www.setup.ru

4.7. Разработка руководства пользователя (оператора)

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

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

Примерный план написания руководства пользователя в соответствии с ГОСТ 19.505-79 «Руководство оператора» /2/:

1. Действия при запуске программы (какой файл должен быть запущен, какие действия должны при этом выполняться).

2. Структура программы (какие окна есть, как между ними переключаться, структура меню и назначение его элементов).

3. Каким образом осуществляется ввод данных.

4. Какая информация выводится на экран.

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

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

5. Оформление пояснительной записки

Оформление пояснительной записки к курсовой работе выполняется в соответствии правилами, принятыми кафедрой «Программное обеспечение» /3/.

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

При описании литературного источника необходимо указать /4,5/:

• фамилии и инициалы авторов,
• название книги или статьи,
• место издания,
• издательство,
• год издания.

• адрес сайта,
• наименование сайта.

6. Защита курсовой работы

• правильность и работоспособность программы, полнота ее функциональных возможностей, интерфейс пользователя;
• знание среды программирования и основ алгоритмизации, степень владения материалом;
• аккуратность оформления пояснительной записки;
• соответствие материалов работы требованиям ГОСТ и правилам, установленным кафедрой;
• понимание использованных математических методов;
• изложение материалов в устном докладе.

Источник: studfile.net

Техническая документация

разработка техдокументации по ГОСТ без бумаги и расстояний

Как писать руководство пользователя? Часть II — обобщенная структура руководства пользователя по ГОСТ 19.ххх, IEEE Std 1063-2001 и пример наполнения руководства пользователя содержимым

Обобщенная структура руководства пользователя программы на основе ГОСТов 19-й системы, IEEE Std 1063-2001 и с учетом рекомендаций «манифеста Кагарлицкого», установлена степень опциональности разделов руководства в зависимости от того, кому поставляется программа, частично заполнены разделы и подразделы руководства. Редакция от 23.01.2022.

Создан 23.02.2005 11:49:29

Пуркуа бы да не па?

Почему бы нет? Взять лучшее из ГОСТов 19-й системы, — обобщенную структуру руководства пользователя, добавить к ней немногочисленные толковые рекомендации из IEEE Std 1063-2001 и разбавить неисчерпаемой стилистической культурой и ресурсами языка из манифеста Кагарлицкого? Придать смеси стройный строгий вид, сформировать очередной учебно-тренировочный документ с подробными комментариями? А что делать, если ни один из перечисленных выше источников и составных частей в отдельности не способны дать ответы на все поставленные вопросы?

На этой жизнеутверждающей ноте оборвалась предыдущая статья, не дав ответа на второй вопрос и породив целый ряд дополнительных.

Цели и задачи

Некоторые маститые технические писатели возмущены приверженностью автора к ГОСТ 7.32, структура разделов которого предусматривает как цели, так и задачи. Все просто. Автор ставит цели и решает задачи, в отличие от иных «мастеров технического слова», вся ценность публикаций которых сводится к глубокомысленным «. я вернулся в. я думаю. я полагаю. мне видится. я не могу согласиться. я не понимаю. я не владею, но мне кажется. я не профессионал, но настоятельно рекомендую. я вынужден констатировать невысокий уровень. я считаю, что это гнусные инсинуации. смотреть мою фотографию. » и так далее. Цели прежние. Задачи:

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

Разъяснения к задачам

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

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

Руководство пользователя: из любви к процессам

— Поручик, Вы любите детей?

— Никак нет-с. Но сам процесс.

Как ни прискорбно, но задача освещения процессов (процедур) разработки технической документации в первой части статьи не ставилась. Ибо о процессах имеется отдельная статья — «Автоматизация разработки технической документации. Часть I».

Процесс разработки техдокументации (как и иные процессы интимного характера) — вещь яркая, волнующая воображение многих технических писателей (техписов). Но пользователю, якобы в интересах которого «составляются» руководства, на процесс начхать с высокой колокольни. Пользователю важен результат — грамотное, полное, доступное и непротиворечивое руководство, ему не интересна «мышиная возня» (взаимодействие технического писателя с программерами, менеджерами проектов и пр.). Следует отметить, что ФЗ «О защите прав потребителей» полностью солидарен с пользователем.

Именно из этих соображений освещать в статье процессы внутренней кухни не имеет смысла.

Руководство пользователя: структура разделов

В чем же причина отсутствия интереса к структуре руководства пользователя? Вероятно, многие г-да технические писатели считают, что:

• либо все вопросы по структуре разделов руководства пользователя давным-давно решены и общеизвестны;
• либо структура разделов не имеет принципиального значения.

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

Руководство пользователя: рекомендации манифеста

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

Совершенно верно. В документах описательного характера (да и в любых других документах) всегда следует двигаться от общего к частному. Дедукция, однако.

Общая логика изложения навязывает многоуровневую рубрикацию: более общим уровням описания продукта соответствуют более крупные главы и разделы, более частным и конкретным — более мелкие, подчиненные.

Глупо спорить. Невзирая на то, что структура разделов руководства пользователя попросту навязывается логикой изложения.

Соображения удобства не отменяют логики изложения, а дополняют ее. Собственно говоря, логичное, хорошо структурированное изложение хорошо усваивается и позволяет безошибочно ориентироваться в нем. Изложение должно быть по возможности строгим, единообразным, логически последовательным, состоящим по большей части из готовых формул. Легко видеть, что из соображений удобства автор документации излагает сведения о продукте как бы в несколько обходов: сначала минимальные сведения об установке, настройке и запуске, затем описание наиболее типичных задач, затем подробный обзор всех элементов(? — прим. автора) и функций, затем специальные вопросы.

Вот она, забота о пользователе! Структура разделов руководства пользователя является определяющей при разработке пользовательских руководств.

Автор манифеста решил задачу по-своему, не ссылаясь на ГОСТы 19.ххх и IEEE Std 1063-2001 — альтернативным способом. Важно совпадение результатов. А не как у Незнайки — сколько вариантов решения, столько и вариантов ответов.

Руководство пользователя: обосновано ли отсутствие интереса технических писателей к структуре разделов?

Соответствуют ли перечисленным выше соображениям реальные образцы пользовательских руководств? Начнем с того, что получше. Исследуем (поверхностно) образцы творений «бригады» технических писателей, плодотворно работающих в известной российской софтверной компании.

Автор умышленно не указывает ни названия компании, ни имен (никнеймов) контактных лиц, предоставивших образцы документов. Мотивировка проста: нет желания бросить тень на светлый образ организации, с отдельными представителями которой автор знаком аж с момента ее основания. Поэтому — минимум информации (максимум конфиденциальности).

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

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

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

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

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

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

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

Выводы

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

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

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

С одной стороны, по мнению автора образца,

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

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

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

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

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

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

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

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

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

«Фермером родился — простофилей умрешь»

Энди Таккер, Бендер Заокеанский

В то же время не следует думать, что стандартная структура — это готовый бланк, в который только вписываются сведения о конкретном продукте. Каждый новый продукт — это своего рода вызов стандарту; он требует втиснуть новые реалии в типовые ячейки, что зачастую вызывает проблемы.

Автор манифеста утверждает, что каждое (вновь разрабатываемое) программное изделие обладает уникальнейшими, свойственными исключительно ему, программному изделию, параметрами, характеристиками, функциональными возможностями, которые принципиально невозможно разбросать по типовой структуре разделов. Какие новые реалии автор манифеста не в силах втиснуть в «ячейки» типовой структуры? Сформировавшийся за последние пятнадцать лет графический пользовательский интерфейс? Да запросто. См. «Как писать руководство оператора по ГОСТ 19.505-79?»

Заглянем в будущее. Наша оборонка придумала (а буржуи украли) бесконтактный пользовательский интерфейс. По типу терменвокса.

Для тех, кто не в курсе. Терменвокс — первый в мире электромузыкальный инструмент, изобретенный в России в начале прошлого века Львом Сергеевичем Терменом. Звукоизвлечение было основано на изменении емкости связки «антенна терменвокса — человеческое тело».

Иными словами, человек определенным образом «гнул пальцы» перед антенной, емкость изменялась, изменялась частота задающего генератора терменвокса (высота воспроизводимого звука). Возможности инструмента демонстрировались в Кремле В. И. Ленину. Старые большевики вспоминают, что Владимир Ильич моментально освоил технику игры и самостоятельно довел мелодию, начатую Терменом, до конца.

Так вот, возможно ли втиснуть описание бесконтактного пользовательского «терменфейса» в типовые ячейки структуры? Без особых проблем. Фрагмент руководства из будущего: «. для печати документа следует сложить пальцы фигой» (изображения «лап» и «перстов» из «руководств» окажутся весьма кстати).

Программа родилась программой — программой и умрет (завершит свой жизненный цикл). Какими бы голографическими пользовательскими интерфейсами программу ни оснащали.

Руководство пользователя: степень опциональности отдельных разделов

Степень опциональности отдельных разделов руководства пользователя объяснима с позиции назначения программного изделия (и руководства к нему). Для кого разрабатывается (тиражируется) программное изделие:

• для конкретного заказчика (З);
• для «дома и офиса» — для пользователя (П).

Опциональность отдельных разделов руководства пользователя будет классифицироваться тремя степенями:

• Н — раздел настоятельно рекомендуется;
• Р — раздел рекомендуется;
• О — раздел опционален.

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

Руководство пользователя: избавление от «старообразности» заголовков разделов

Указанная задача также требует разъяснений, поскольку один и тот же заголовок раздела руководства пользователя, структура которого (в целом) сформирована в первой части статьи, может трактоваться неоднозначно или попросту вызывать недоумение. К примеру, раздел «Входные точки в программу».

Примечание от 11.06.2014 г. — А знаете ли вы, что такое рычажный указатель? Скорее всего нет, поскольку это «Рычаг, который имеет не менее двух степеней свободы, используемый в качестве устройства ввода позиции [из п. 57 табл. 1 ГОСТ 27459-87]». А в переводе на современный язык «просвещенной русской интеллигенции» — просто джойстик.

Руководство пользователя: компромиссный вариант структуры

Компромиссный вариант структуры руководства пользователя должен устраивать «и наших, и ваших»:

• «наших» — удовлетворять требованиям стандартов 19-й системы (и здравого смысла);
• «ваших», включая:

• рекомендации IEEE Std 1063-2001 (для любителей всего «заграничненького»);
• рекомендации манифеста Кагарлицкого (для любителей изящного, изысканного построения фраз);
• фантазии «технических писателей всех времен и народов», коим техническая документация, разработанная согласно требований «увесистого тома ГОСТ 19.ххх», не дает покоя и кажется «составленной непонятно и дурно».

Компромиссный вариант, по мере его формирования (в табличке), и предлагается к обсуждению.

Компромиссный вариант структуры разделов руководства пользователя

Цифры 1, 2 и т.д. соответствуют уровню вложенности заголовка.

Наименование раздела (подраздела)

Источник: tdocs.su