Документация

1. Введение

В разделе «Введение» указывают:

1. область применения;
2. краткое описание возможностей;
3. уровень подготовки пользователя;
4. перечень эксплуатационной документации, с которой необходимо ознакомиться пользователю.

1.1. Область применения

Требования настоящего документа применяются при:

• предварительных комплексных испытаниях;
• опытной эксплуатации;
• приемочных испытаниях;
• промышленной эксплуатации.

1.2. Краткое описание возможностей

Информационно-аналитическая система Корпоративное Хранилище Данных (ИАС КХД) предназначена для оптимизации технологии принятия тактических и стратегических управленческих решений конечными бизнес-пользователями на основе информации о всех аспектах финансово-хозяйственной деятельности Компании.

ИАС КХД предоставляет возможность работы с регламентированной и нерегламентированной отчетностью.

При работе с отчетностью используется инструмент пользователя Oracle Discoverer Plus, который предоставляет следующие возможности:

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

1.3. Уровень подготовки пользователя

Пользователь ИАС КХД должен иметь опыт работы с ОС MS Windows (95/98/NT/2000/XP), навык работы с ПО Internet Explorer, Oracle Discoverer, а также обладать следующими знаниями:

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

Квалификация пользователя должна позволять:

• формировать отчеты в Oracle Discoverer Plus;
• осуществлять анализ данных.

Инструкции по производителям

A…

Acer
Acura
ACV
AdvoCam
AEG
Al-ko
Alcatel
Alligator
Alpine
AND
APC
Apple
APS
Ardo
Ariston
Artway
AstraLux
Asus
ATLANT(АТЛАНТ)
Atmor
Aurora
Awelco

B…

B.Well
Ballu
BAXI
BBB
BBK
Beko
BenQ
Beretta
BEURER
Blackview
Blackvue
BlueWeld
Bomann
Boneco
Bork
Bosch
BQ
Braun
Bresser
Brother
Buderus

C…

Cadillac
Caiman
Can Am
Candy
Canon
Cas
Casio
CatEye
Celestron
Cem
CENMAX
Centurion
Chaffoteaux
Champion
Chevrolet
CITIZEN
Citroen
Clarion
Clatronic
Cobra
Condtrol
Crunch

H…

Haier
Hansa
HARPER
Highscreen
Hisense
Hitachi
Honda
Hotpoint-Ariston
Hotter
HP
HTC
HUAWEI
Huter
Hyundai
Hyundai Electronics

M…

Makita
Marta
Massa-K
Maxvi
Medisana
Microlife
Micromax
Microsoft
Midea
Miele
Mio
Mitsubishi
Mongoose
Motorola
Moulinex
MSI
Multitronics
Mystery

P…

Panasonic
Pandora
Pantera
ParkCity
Pentax
Perfeo
Peugeot
Phantom
Pharaon
Philips
Pioneer
Playme
PocketBook
Polar
Polaris
Polaris Industries Inc
Pozis
Prestige
Prestigio
PROLOGY
Prorab
Protherm

S…

Saeco
Samsung
Sanyo
Saturn
Scarlett
Scher-Khan
Sharp
Sheriff
Shivaki
SHO-ME
Siemens
Sigma
SilverStone F1
Singer
Ski Doo
Skoda
Smeg
Sony
Sony Ericsson
Soundmax
StarLine
Stealth
Stels
Stiebel Eltron
Street Storm
Stropuva
Subaru
Subini
Supra
Suzuki
SVEN
SWAT
Synta

Первая инструкция к автосигнализациям

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

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

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

Первая инструкция к фотоаппарату

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

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

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

5. Аварийные ситуации

В разделе «Аварийные ситуации» указывают: 1. действия в случае несоблюдения условий выполнения технологического процесса, в том числе при длительных отказах технических средств; 2. действия по восстановлению программ и/или данных при отказе магнитных носителей или обнаружении ошибок в данных; 3. действия в случаях обнаружении несанкционированного вмешательства в данные; 4. действия в других аварийных ситуациях.

В случае возникновения ошибок при работе ИАС КХД, не описанных ниже в данном разделе, необходимо обращаться к сотруднику подразделения технической поддержки ДИТ (HelpDesk) либо к ответственному Администратору ИАС КХД.

Разработайте план и напишите текст

После тщательного изучения материала можно приступать к планированию. Продумайте, с чего лучше начать и чем продолжить. На примере инструкции к пылесосу «Xiaomi mi robot vacuum cleaner» я расскажу о принципах написания такого текста.

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

Содержание руководства пользователя на примере инструкции к пылесосу

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

Описание продукта на примере инструкции к пылесосу «Xiaomi mi robot vacuum cleaner»

Не пишите специальные термины, понятные только узкому кругу читателей. Текст должен быть понятен любому. Если без этого никак — распишите каждый термин понятным языком.

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

Добавляйте в статью скриншоты. Наглядно понять работу программы или техники намного проще.

Добавляем скриншоты для наглядности (пример)

Пишите даже те моменты, которые кажутся очевидными и понятными без описания. Они понятны вам. Но не факт что и всем остальным тоже.

Пишите текст короткими предложениями с глаголами повелительного наклонения: «Включите компьютер», «Нажмите на кнопку…», «Включите в розетку…».

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

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

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

После того как статья будет готова — дайте её прочитать другу или знакомому, и спросите, насколько она понятна. Так вы сможете исправить недочёты и испытать ваш текст в действии.

Ой-ой, твой браузер не поддерживает видео.

Руководство по ТО и текущим видам ремонта тепловозов:

«Руководство по техническому обслуживанию и текущему ремонту тепловозов ТЭМ2ИО» утвержденное вице-президентом ОАО «РЖД» В.А. Гапановичем от 31 декабря 2004г.

«Руководство по техническому обслуживанию и текущему ремонту тепловозов ТЭ10ИО» утвержденное вице-президентом ОАО «РЖД» В.А. Гапановичем от 31 декабря 2004г.

«Руководство по техническому обслуживанию и текущему ремонту тепловозов М62ИО» утвержденное вице-президентом ОАО «РЖД» В.А. Гапановичем от 25 декабря 2004г.

«Руководство по техническому обслуживанию и текущему ремонту тепловозов ТЭМ7 и ТЭМ7А» утвержденное главным инженером Людиновского тепловозостроительного завода В.И. Савенко.

Инструкции по типу техники

Автотехника…

CD-чейнджеры
GPS-навигаторы
Автоакустика
Автовидеорегистраторы
Автомагнитолы
Автомобили
Автомобильные колонки
Автомойки
Автосигнализации
Автоусилители
Алкотестеры
Антенны
Бортовые компьютеры
Зарядные устройства
Парктроники
Радар-детекторы

Аудио…

Акустика
Диктофоны
Караоке
Магнитолы
Микрофоны
Музыкальные центры
Наушники
Плееры
Радиоприемники
Ресиверы и усилители
Синтезаторы, цифровые пианино

Видео…

Blu-Ray проигрыватели
CD-проигрыватели
DVD-проигрыватели
Видеодвойки
Видеокамеры
Видеомагнитофоны
Домашние кинотеатры
Проекторы
Системы видеонаблюдения
Телевизионные приставки
Телевизоры OLED
Телевизоры ЖК
Телевизоры кинескопные
Телевизоры плазменные

Дом и дача…

Газонокосилки
Генераторы
Домофоны
Культиваторы
Насосы
Охранные сигнализации
Преобразователи частоты
Садовые пилы
Сварочное оборудование
Снегоуборщики

Климатическая…

Бойлеры
Вентиляторы
Ионизаторы
Керамические тепловентиляторы
Конвекторы
Кондиционеры
Котлы
Масляные обогреватели
Обогреватели
Очистители воздуха
Радиаторы
Сплит-системы
Тепловентиляторы
Увлажнители воздуха

Компьютерная…

UPS (источники бесперебойного питания)
Игровые приставки
Калькуляторы, органайзеры
Карманные компьютеры
КПК и коммуникаторы
Маршрутизаторы
Материнские платы
Мини ПК
Мониторы
Моноблоки
МФУ (многофункциональные устройства)
Мыши
Ноутбуки
Памяти и накопители
Планшеты
Принтеры лазерные
Принтеры матричные
Принтеры струйные
Программное обеспечение
Системные блоки
Сканеры
Устройства Wi-Fi, роутеры

Крупная бытовая…

Газовые водонагреватели
Морозильные камеры
Посудомоечные машины
Пылесосы
Стиральные машины
Сушильные машины
Холодильники
Эл. водонагреватели

Кухонная…

Аэрогрили
Блендеры
Блинницы
Варочные панели
Вытяжки
Духовые шкафы
Измельчители
Комбайны
Кофеварки
Кофемашины
Кофемолки
Микроволновые печи
Миксеры
Мороженицы
Мультиварки
Очистители воды
Пароварки
Плиты
Ростеры
Скороварки
Соковыжималки
Термопоты
Тостеры
Фритюрницы
Хлебопечки
Чайники
Электрические печи
Электромельнички
Электромясорубки

Мелкая бытовая…

Весы
Маникюрные наборы
Массажеры
Машинки для стрижки
Метеостанции
Отпариватели
Пароочистители
Радионяни
Термометры
Утюги
Фены
Часы
Швейные машинки
Эл. зубные щетки
Электробритвы, эпиляторы

Цель разработки руководства

Группы лиц, которым может понадобиться инструкция – это не только обычные потребители, но и специалисты, осуществляющие ремонт и техническое обслуживание, сотрудники предприятий.

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

РЭ относится к категории конструкторской документации, наряду с паспортом на изделие, сборочной схемой и габаритными чертежами. Все перечисленное может понадобиться:

• Когда изготавливается новое изделие (для передачи заказчику);
• При сертификации продукции (передается в сертификационный центр);
• При импорте и таможенных досмотрах.

Данные, собираемые при посещении сайта

Персональные данные

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

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

Данные собираются имеющимися на сайте формами для заполнения (например, регистрации, оформления заказа, подписки, оставления отзыва, обратной связи и иными).

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

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

Не персональные данные

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

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

4. Описание операций

В разделе «Описание операций» указывают:

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

Для каждой операции обработки данных указывают:

1. наименование;
2. условия, при соблюдении которых возможно выполнение операции;
3. подготовительные действия;
4. основные действия в требуемой последовательности;
5. заключительные действия;
6. ресурсы, расходуемые на операцию.

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

4.1. Выполняемые функции и задачи

Oracle Discoverer Plus в составе ИАС КХД выполняет функции и задачи, приведенные в таблице ниже:

Как разработать документ?

Для разработки инструкции следует обращаться к специалистам.

Эксперты нашего центра помогут сориентироваться во всех требованиях стандартов. Мы оказываем услуги по разработке РЭ и правильно составим его в короткие сроки.   

Какие сведения потребуются?

Для разработки РЭ специалистам нужно будет предоставить ряд документов, таких как:

• Заявление;
• Описание продукции;
• Отсканированные копии учредительной документации;
• Реквизиты заявителя.

Для уточнения информации о составлении РЭ для вашей продукции обращайтесь к специалистам нашего центра удобным для вас способом. Мы оперативно ответим на все возникшие вопросы.

Примеры

Платежный терминал «РобоКассир».
Руководство по эксплуатации

Платежный терминал «РобоКассир»
предназначен для автоматического приема наличных платежей и применяется в
составе различных платежных систем. Руководство по эксплуатации
терминала разработано «Философтом» по заказу компании PayNet
(название изменено).

1. Введение 
 1.1. Условные обозначения 
 1.2. Общие сведения о платежном терминале 
 1.3. Основные характеристики платежного терминала 
 1.4. Требования к квалификации персонала 
2. Конструкция и основные характеристики платежного терминала 
3. Комплект поставки 
 3.1. Состав комплекта поставки 
 3.2. Платежный терминал в собранном виде 
  3.2.1. Комплектация платежного терминала 
  3.2.2. Основа-корпус платежного терминала 
  3.2.3. Источник бесперебойного питания 
  3.2.4. Источник питания узлов платежного терминала 
  3.2.5. Источник питания термопринтера 
  3.2.6. IBM-совместимый компьютер 
  3.2.7. Сенсорный монитор 
  3.2.8. Рекламный монитор 
  3.2.9. Купюроприемник 
  3.2.10. Чековый термопринтер 
  3.2.11. Мобильное шасси для размещения жесткого магнитного диска 
  3.2.12. Беспроводной GSM/GPRS-модем 
 3.3. Сетевой кабель питания 
 3.4. Выносная антенна 
 3.5. Жесткий магнитный диск с программным обеспечением 
 3.6. Эксплуатационная документация на платежный терминал 
 3.7. Комплекты ключей от верхней и нижней дверцы терминала 
 3.8. Документ со списком паролей 
4. Порядок открывания и закрывания дверей 
5. Включение и выключение платежного терминала 
6. Уход за терминалом 
7. Запуск платежного терминала 
 7.1. Пробный запуск 
 7.2. Запуск в рабочем режиме 
8. Узлы платежного терминала и их обслуживание 
 8.1. Электропитание платежного терминала 
  8.1.1. Общие рекомендации 
  8.1.2. Источник бесперебойного питания, его эксплуатация и устранение неполадок 
  8.1.3. Блок питания платежного терминала, его эксплуатация и устранение неполадок 
 8.2. Термопринтер и его обслуживание 
  8.2.1. Общие замечания 
  8.2.2. Citizen PPU-700 
  8.2.3. Custom VKP-80 
 8.3. Купюроприемник и его обслуживание 
  8.3.1. Общие замечания 
  8.3.2. Конструкция купюроприемника 
  8.3.3. Автотестирование купюроприемника при его включении 
  8.3.4. Эксплуатация и обслуживание купюроприемника 
 8.4. Мониторы и их обслуживание  
  8.4.1. Общие замечания 
  8.4.2. Сенсорный монитор 
  8.4.3. Рекламный монитор 
 8.5. Модем и антенна, их эксплуатация и обслуживание 
  8.5.1. Общие замечания 
  8.5.2. Wavecom Fastrack M1206B и Fastrack M1306B 
  8.5.3. Siemens MC-35i Terminal 
  8.5.4. Обслуживание модема и антенны 
 8.6. Узлы компьютера и их обслуживание 
  8.6.1. Системная плата 
  8.6.2. Видеоплата 
  8.6.3. Проверка памяти 
  8.6.4. Жесткий диск и его обслуживание 
 8.7. Корпус 
9. Специфические настройки терминала 
 9.1. Общие замечания 
 9.2. Настройка изображения на сенсорном экране 
 9.3. Настройка устройств 
 9.4. Настройки в БСВВ 
 9.5. Сбрасывание настроек БСВВ
10. Меры безопасности 
11. Хранение и транспортировка платежного терминала 
 11.1. Хранение 
 11.2. Транспортировка 
12. Списание и утилизация платежного терминала 
Приложение A. Неисправности терминала и их устранение 
Приложение B. Функции программного обеспечения терминала 
Приложение C. Настройка узлов и устройств терминала 
 C.1. Общий порядок настройки 
 C.2. Купюроприемник 
 C.3. Принтер 
 C.4. Источник бесперебойного питания 
 C.5. Модем 
 C.6. Сенсорный экран 
 C.7. Окно настроек и доступные из него функции