Электронное справочное руководство для - Arganabio.ru - инструкции по эксплуатации и многое другое

Содержание

Зачем нужен мануал
Что такое User Manual и Service Manual
Что такое User Manual
Зачем нужен User Manual?
Что такое Service Manual?
Как мне помог Service Manual
MANUAL
Смотреть что такое MANUAL в других словарях:
MANUAL
MANUAL
MANUAL
MANUAL
MANUAL
MANUAL
MANUAL
MANUAL
MANUAL
MANUAL
MANUAL
MANUAL
MANUAL
MANUAL
MANUAL
MANUAL
MANUAL
MANUAL
MANUAL
MANUAL
MANUAL
MANUAL
MANUAL
MANUAL
MANUAL
MANUAL
MANUAL
MANUAL
MANUAL
MANUAL
MANUAL
MANUAL
MANUAL
MANUAL
MANUAL
MANUAL
MANUAL
MANUAL
MANUAL
MANUAL
MANUAL
MANUAL
MANUAL
MANUAL
MANUAL
MANUAL
MANUAL
MANUAL
MANUAL
Что такое мануал?
мануал
Смотреть что такое «мануал» в других словарях:

Зачем нужен мануал

Представить трудно, но в наше время некоторые люди до сих пор не умеют правильно читать. Это надо понимать так: люди не умеют читать инструкции, люди не умеют получить нужную им в данный конкретный момент информацию.
А если человек не умеет «читать» на необходимом уровне, то его ждет беда. Вот почему президент Ассоциации школьных библиотек России Татьяна Жукова считает, что именно это приводит к всевозможным техногенным катастрофам.
Наверное, в наше время найдется еще немало каких-то других причин, которые приводят к чрезвычайным происшествиям. Однако так называемая функциональная неграмотность будет не на последнем месте в печальном списке возможных причин аварий и катастроф. И для того, чтобы ничего подобного не происходило, и существуют так называемые инструкции по эксплуатации.

Что представляет собой этот документ, понять нетрудно. В нем подробно описывается какое-то устройство, а также приводятся правила того, как необходимо пользоваться им. И совсем неважно, что представляет собой это устройство. Это может быть телевизор или компьютер, микроволновая печь или стиральная машина.
Однако все они требует к себе пристального внимания. В том смысле, что во время работы с ними обязательно необходимо соблюдать всё, что написано в инструкции. В противном случае любая машина выходит из строя, а хуже всего, когда это сопровождается травматизмом.
Проявляя заботу о своем клиенте и потребителе, производители всех изделий готовят для них специальные буклеты с подробной инструкцией по эксплуатации. Они обязательно входят в комплект поставки.
Если кто-то называет эту инструкцию по эксплуатации мануалом (manual), то не удивляйтесь. Речь идет об одном и том же. А user guide или user manual в переводе с английского, как нетрудно догадаться, означает руководство по эксплуатации, руководство оператора.
Там есть вся необходимая информация. Что представляет собой изделие? Какие у него части и механизмы? Как необходимо последовательно производить сборку? Как настраивать машину? Как включать и выключать? Ответы на эти и многие другие вопросы, вы найдете в том самом буклете.
Кстати, мануал необходимо воспринимать как солидную работу технического писателя. Это именно он порой очень сложные процессы во всевозможных устройствах описывает так, чтобы перенасыщенный терминами и понятиями язык технических работников был понятен каждой домохозяйке.
А чтобы читать такие тексты было несложно, в буклете обычно в помощь потребителю находится место и для всевозможных иллюстраций, чертежей, схем.
И все для того, чтобы человек все сделал по инструкции, а не как-то иначе. Причем на сегодня существует такое понятие, как пошаговая инструкция. Это означает, что постепенно, шаг за шагом, в определенном порядке, а не иначе следует выполнять требования руководства пользователя. И тогда все получится. Найдется там место и для правил безопасности при работе с оборудованием. Это обязательно! К сожалению, человеку всегда нужно напоминать о том, что электрический ток, работа всевозможных механизмов представляет опасность. Поэтому об этом обязательно пишут в руководствах пользователя тоже.
Причем необходимо подчеркнуть, что пишут все тексты на русском языке, если товар реализуется на территории России. Для любого товара, а уж тем более для какого-либо сложного технического устройства, это очень важно! И совсем не имеет значения, в какой стране произвели ту или иную машину, прибор, аппарат. Инструкция по эксплуатации должна быть только на русском языке.
Производитель обязан собственными силами разрабатывать инструкции по эксплуатации, но он также и заинтересован в этом сам. И потому он ищет неординарные формы подачи материала. То есть он может выполнить инструкцию не только в форме буклета, но в форме наклейки или надписей краской на самом устройстве. Когда мануал находится всегда перед глазами, то его предназначение в таком случае оправдано вдвойне.
Есть и другие формы достучаться до потребителя. Многие компании, особенно всемирно известные, считают необходимым размещать инструкции по эксплуатации в глобальной сети. Отдача от таких Интернет-ресурсов достаточно большая. Ведь при необходимости пользователь может посетить нужный ему сайт, чтобы что-то прочитать, что-то посмотреть и в итоге правильно пользоваться устройством, а тем самым значительно продлить сроки его эксплуатации.
Электронные версии инструкции по эксплуатации, причем в любом формате, сейчас приобретают все большую популярность и находят все большее использование. Пользователь, которому, например, нужен мануал по эксплуатации, может скачать его в pdf, doc, как и в любом другом формате. С учетом того, что у многих дома есть компьютер, электронная версия становится реальностью.
Но иногда бывают такие товары, которые сегодня уже в себе носят пошаговую инструкцию по эксплуатации. Таковым может быть, скажем, телевизор. Достаточно посмотреть на этом самом телевизоре соответствующие видеоролик, чтобы получить ответы на интересующие вопросы по эксплуатации.
Также при покупке можно получить компакт-диск с PDF-файлами. А это предполагает, что у владельца даже полностью автономного ИТ-гаджета обязательно есть дома или на работе компьютер или иное устройство, умеющее выводить PDF-файлы на экран, или печатающее устройство. Действующее законодательство поддерживает такой способ просвещения потребителей.
Остается добавить, что в документации, которая прилагается к товару, вы, конечно, можете найти информацию и о том, как ремонтируют устройство, а самое главное, где находится тот самый сервисный центр, который возьмется за восстановление нормальной работы вашего агрегата.

Источник

Что такое User Manual и Service Manual

Приветствую, друзья!

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

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

Большинство используемой нами техники — зарубежного производства. Из зарубежья же пришли к нам в нагрузку эти словосочетания — User Manual и Service Manual.

Без этих мануалов – ни туда и ни сюда!

Что такое User Manual

Нам надо все сразу и быстро!

И только когда с техникой что-то не ладится — мы начинаем этот самый мануал изучать.

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

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

Современная техника — это умные машины, наделенные электронным интеллектом.

Они способны подавать нам сигналы посредством индикаторов (как звуковых, так и визуальных), сообщающих о ее здоровье.

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

Чем сложнее аппарат, тем толще его User Manual. Так, руководство пользователя на МФУ Xerox 3635 насчитывает 238 страниц!

Начинается сия книга с правил техники безопасности.

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

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

Но мало кто читает! Может быть, поэтому уважительное отношение к технике встречается редко.

Зачем нужен User Manual?

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

Не нужно вызвать поддержку и платить деньги!

При чтении руководства пользователя можно выяснить интереснейшие вещи. Вот вы, например, знаете, каков уровень излучения вашего мобильного телефона или смартфона? Эти штуки излучают СВЧ энергию, нагревая наш мозг.

Между тем, голова существует в единственном экземпляре, и запчастей к ней не положено!

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

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

Что такое Service Manual?

Чем сложнее техника, тем ниже ее надежность. Когда-нибудь она обязательно сломается! Или ее сломает пользователь. И она попадет к сервисному инженеру в ремонт. Вот тут инженеру будет очень кстати Service Manual — руководство по обслуживанию и ремонту.

Это книженция еще толще, чем юзер мануал.

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

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

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

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

Следует отметить — Service Manual гораздо менее доступен, чем User Manual. Некоторые фирмы-производители считают информацию, размещенную в сервис мануале, конфиденциальной. И предоставляют ее исключительно авторизованным сервисным центрам.

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

Как мне помог Service Manual

Сервис мануал — очень хорошая штука! Как-то мне попал в ремонт струйный принтер Epson. Он периодически мазал с одной стороны листа. Тщательно осмотрев механическую часть, я никаких поломок не заметил.

Изучив Service Manual, я понял, как регулируется расстояние от печатающей головки до листа бумаги.

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

Пока не осенило: на заводе изготовителе забыли поставить стойку-опору! В шасси отверстие под нее было, а самой стойки не было. Аппарат прошел технический контроль и какое-то время нормально работал! Дальше уже было дело техники: стойка была изготовлена из подручных материалов и поставлена на штатное место.

Аппарат заработал как швейцарские часы!

Без Service Manual голову пришлось бы напрягать сильнее и дольше…

Заканчивая статью, отметим, что многие (хотя и далеко не все) Service Manual можно найти в интернете. Есть бесплатные библиотеки, есть коммерческие.

Образование – это способ преодолеть превратности судьбы, друзья!

Источник

MANUAL

Manual — 1) Руководство, описание, справочник, учебник.
2) Учебник по пользованию программой. Как прилагательное: «ручной»; режим изменений, совершаемых пользователем, а не компьютером

Смотреть что такое MANUAL в других словарях:

MANUAL

[`mænjʊəl]руководство; наставление; справочник, указатель; учебникприемы владения оружиемручной регистр клавиатуры органаприбор с ручным управлениемруч. смотреть

MANUAL

manual: translation•Roman•I.•/Roman• nounADJECTIVE ▪ how-to (esp. AmE), instruction, instructional (esp. AmE), training ▪ advice, self-help ▪ oper. смотреть

MANUAL

manual: translation ▪ I. manual man‧u‧al 1 [ˈmænjuəl] adjective 1. using your hands and your physical strength or abilities, rather tha. смотреть

MANUAL

1. сущ..1)а) общ. руководство, инструкция, справочник, указательuser(‘s) manual — руководство пользователяmaintenance manual — руководство по техническ. смотреть

MANUAL

Manual: übersetzung Richtschnur; Anleitung; Handbuch; Leitfaden * * * Ma|nu|al 〈n. 11〉 1. 〈Mus.〉 Handtastenreihe bei Orgel, Harmonium, Cembalo 2. 〈ver. смотреть

MANUAL

1. ручной; действующий от руки; с ручным управлением 2. руководство; инструкция; справочник * * *руководство; справочник; наставление; инструкция— en. смотреть

MANUAL

1. <ʹmænjʋəl>n 1. 1) руководство; наставление; справочник, указатель; учебник shorthand

— руководство /учебник/ по стенографии Manual of Military. смотреть

MANUAL

manual [ˊmænjυǝl] 1. n 1) руково́дство; наставле́ние; спра́вочник, указа́тель; уче́бник;field manual боево́й уста́в 2) воен. приёмы ору́жием 3) клави. смотреть

MANUAL

manual 1. [ʹmænjʋəl] n 1. 1) руководство; наставление; справочник, указатель; учебник shorthand

— руководство /учебник/ по стенографии Manual of Mi. смотреть

MANUAL

1. adj1) ручной, сделанный рукамиtrabajo manual — ручная работа2) см. manuable3) выполнимый, осуществимый4) частый, нередкий; обычный5) уст. лёгкий, бы. смотреть

MANUAL

1. nнастанови; інструкція; довідник, підручник; військ. статут2. aручний, з ручним керуванням•- Aeroplane Flight Manual- field manual- flight manual- f. смотреть

MANUAL

1) руководство2) немеханизированный3) чернорабочий4) <engin.> ручной5) приводимый в движение вручную6) пособие7) учебник8) наставление9) инструкц. смотреть

MANUAL

1) учебник2) руководство; справочник; инструкция3) клавиатура (наборной машины) с ручным управлением- manual of instruction- instruction manual- printi. смотреть

MANUAL

1. руководство; инструкция 2. ручной- concrete plant operator’s manual- manufacturer’s instruction manual- quality manual- service manual- steel d. смотреть

MANUAL

manual: übersetzungmanual 1. Handbuch n, Gebrauchsanweisung f; 2. Richtlinienkatalog m

MANUAL

1) инструкция; руководство 2) ручной, с ручным управлением •- factory repair manual- maintenance manual- operating manual- owner’s manual- reference ma. смотреть

MANUAL

I adj1) ручной trabalho — ручной труд2) лёгкий (не тяжёлый) 3) портативный, удобный II mучебник, руководство

MANUAL

Описпосібникінструкціядовідникпідручникз ручним управліннямфізичнийручнийнеавтоматизований

MANUAL

transcription, транскрипция: [ ˈmænjuəl ] справочник ; руководство ; учебник ; указатель ; ручной, физический (о труде) ; неавтоматический, приводимый в движение вручную ;

MANUAL

fail to provide the manuals — не обеспечивать (экипаж) соответствующими инструкциями— airman’s information manual

MANUAL

1) інструкція, керівництво, настанова (документ); військ. статут 2) ручний, неавтоматичний • manual deliverymanual filing systemmanual giftmanual occupationManual of Military Lawmanual signature. смотреть

MANUAL

1. n 1) підручник, посібник; довідник; покажчик; 2) статут; 3) муз. мануал (органа); 2. adj ручний;

labour фізична праця;

training уроки праці (у школі);

control ручне управління. смотреть

MANUAL

Учебник; Руководство; справочник; инструкция; Клавиатура (наборной машины) с ручным управлением; Карманный справочник; Руководство. Краткий толковый словарь по полиграфии.2010. смотреть

MANUAL

ручной приём, ручной способ* * *• ручной прием • ручной способ

MANUAL

• (adj.) с ручным управлением• инструкция

MANUAL

легко выполнимый легко управляемый 3)руководство 4)рукоять 5)с ручным управлением 6)удобный в обращении 7)учебник 8)учебное пособие

MANUAL

описпосібник інструкція довідник підручник з ручним управлінням фізичний ручний неавтоматизований

MANUAL

мед.сущ. руководство; ручной; вручную * * * мануальный Англо-русский медицинский словарь.2012.

MANUAL

ˈmænjuəlручной, с ручным управлением, неавтоматический

Источник

Что такое мануал?

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

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

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

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

Тем не менее, стоит знать, что у данного термина существуют иные значения. Например, под словом «мануал» могут подразумевать клавиатуру органа.

Понравилась заметка? Тогда время подписываться в социальных сетях и делать репосты!

Источник

мануал

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

Смотреть что такое «мануал» в других словарях:

МАНУАЛ — (лат.). Клавиатура в органе, на которой играют руками, в отличие от клавиатуры педальной, на которой действуют ногами; манул в органе несколько. Словарь иностранных слов, вошедших в состав русского языка. Чудинов А.Н., 1910. МАНУАЛ ит., от mano,… … Словарь иностранных слов русского языка

Мануал — Мануал: Руководство пользователя Мануал (орган) клавиатура органа Manual в скейтбординге, езда на двух парных колёсах скейта, не касаясь земли остальными … Википедия

мануал — сущ., кол во синонимов: 4 • букварь (14) • клавиатура (3) • ман (3) • … Словарь синонимов

мануал — [29/0] от англ. manual – «руководство» руководство пользователя по использованию какой либо программы или ресурса. Прочитай мануал, и поймешь как пользоваться этой прогой. Компьютерный сленг … Cловарь современной лексики, жаргона и сленга

мануал — (manuale; лат. mamialis ручной) сборник прописей лекарственных форм, фармацевтических (галеновых) препаратов и других технических продуктов и материалов, используемых в медицинской практике, но не вошедших в фармакопею … Большой медицинский словарь

Мануал — клавиатура органа, на которой играют руками; она называется так в отличие от клавиатуры для ног (pedale). M. в органе бывает несколько (см. Орган) … Энциклопедический словарь Ф.А. Брокгауза и И.А. Ефрона

Мануал — (от лат. manualis ручной) клавиатура для рук (в отличие от клавиатуры для ног педали) в многоклавиатурных инструментах (орган, клавесин, фисгармония, электронные инструменты). Число М. в оргбнах 1 7 (7 М. имеет орган в соборе г. Атлантик… … Музыкальная энциклопедия

мануал — I м. Ручная клавиатура органа, фисгармонии, клавесина. II м. Специалист в области мануальной терапии метода лечения какого либо заболевания руками: массажем, вправлением позвонков или суставов и т.п.; мануальный терапевт, мануолог. Толковый… … Современный толковый словарь русского языка Ефремовой

мануал — ману ал, а … Русский орфографический словарь

мануал — (2 м); мн. мануа/лы, Р. мануа/лов … Орфографический словарь русского языка

Источник

User Guide (юзер гайд) — это руководство пользователя. Иногда встречается название User Manual, что тоже можно перевести как руководство пользователя.

User Guide (Руководство пользователя) — это документ, либо приложение, предназначенные для того, чтобы предоставить помощь в использовании компьютера, смартфона, планшета, либо в использовании программы, а также в использовании сайта.

Содержание:
1. Чем полезен User Guide
2. Можно ли удалить User Guide с компьютера
3. Видео: Что такое User Guide и User Manual, польза для пользователя и можно ли это удалить с компьютера

Чем полезен User Guide

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

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

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

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

User Manual на ноутбуке в формате pdf — титульный лист.

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

Юзер гайд на сайтах

На некоторых сайтах можно встретить руководство для пользователя. В качестве примера возьмем сайт Петроэлектросбыта:

На сайте Петроэлектросбыта находится «Инструкция пользователя».

На сайте Петроэлектросбыта внизу, в подвале находится ссылка «Инструкция пользователя». Если по ней кликнуть, сразу же скачается руководство пользователя на 43 листах — файл в формате PDF.

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

Можно ли удалить Юзер гайд с компьютера

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

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

Видео: Что такое User Guide и User Manual, польза для пользователя и можно ли это удалить с компьютера

Руководство пользователя — это полезная вещь, которая облегчает освоение своего устройства. Спасибо за внимание!

Другие материалы:

1. А как у Вас с английским и с другими языками: Google переводчик бесплатно для текста, документа, сайта и речи

2. Компьютерный жаргон: словарик некоторых терминов и их разбор

3. Почему краткость в формулировке вопроса не является сестрой таланта

Получайте новые статьи по компьютерной грамотности на ваш почтовый ящик:

Необходимо подтвердить подписку в своей почте. Спасибо!

Что такое мануал?

Категория:
Что такое?

– Автор:
Игорь (Администратор)

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

Мануал (Manual) — это, в ИТ сфере, руководство пользователя по использованию какой-либо программы, сервиса и тому подобного. Если говорить простыми словами, то это нечто вроде «инструкции для чайников» или «инструкции по применению».

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

Понравилась заметка? Тогда время подписываться в социальных сетях и делать репосты!

☕ Понравился обзор? Поделитесь с друзьями!

Что такое ЧСВ?
Что такое?
Что такое бро?
Что такое?
Что такое мб?
Что такое?
Что такое нуб?
Что такое?
Что такое олдфаг?
Что такое?
Что такое холивар?
Что такое?

Добавить комментарий / отзыв

Источник

Время на прочтение
4 мин

Количество просмотров 28K

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

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

Сам иногда занимаюсь help-файлами и не понаслышке знаю, что создание справочной системы занимает время и является кропотливой и нудной работой, особенно документирование интерфейса. Однако пару месяцев назад открыл для себя инструмент, который значительно ускоряет этот процесс. Речь идет о программе Dr.Explain от самарской компании Индиго Байт Системз. Она мне понравилась продуманным интерфейсом и возможностью документировать интерфейс ПО в полуавтоматическом режиме.

Dr.Explain vs. Help and Manual

Итак, Dr.Explain позволяет создавать help-файлы в формате CHM для поставки вместе с приложением, справочные системы в HTML для размещения на сайте продукта, а также руководства пользователя в RTF и в PDF с оглавлениями и ссылками. Справочная система генерируется в разных форматах из единого источника, что позволяет быстро обновлять документацию при выходе новых версий ПО. В этом плане Dr.Explain ничем не отличается от Help and Manual, которой я давно пользуюсь.

Интерфейс состоит из двух областей. Первая – это панель навигации с древовидной структурой содержания проекта. А вторая – редактор страниц.

В дереве задается вся структура help-файла, включая заголовки папок и страниц. Редактор страниц состоит из стандартных инструментов для написания и форматирования текста, а также имеются инструменты для вставки гиперссылок, картинок, таблиц и переменных. Все это есть и в Help and Manual, но панель инструментов в Dr.Explain скомпонована, на мой взгляд, более продуманно.

Сравним:

Рисунок 1. Панель инструментов Dr.Explain

Рисунок 2. Панель инструментов Help and Manual

Главная фишка Dr.Explain – это автоматизация самого трудоемкого процесса документирования – создание аннотаций пользовательского интерфейса. Да, вы правильно меня поняли. Больше не нужно делать снимки экрана самому, рисовать выноски и стрелки, вставлять все это хозяйство в проект вручную – программа сама сделает снимок любой части интерфейса по вашему выбору, проанализирует и найдет (сама!) все значимые элементы (кнопки, элементы управления, списки), вставит снимок в проект справки и автоматически расставит стрелки и пояснительные выноски к изображениям. Пользователю остается всего лишь ввести краткое пояснение к каждой выноске и все.

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

Такое полуавтоматическое документирование интерфейса значительно ускоряет и облегчает создание справочной системы, т.к. разработчику остается всего лишь добавить свои описания в выноски. В Help and Manual я все это тоже могу сделать – правда, придется делать это вручную. Обычно я делаю снимки окон в Snagit, обрабатываю края снимка, добавляю тень, рисую стрелки. А для документирования элементов окна вручную создаю табличку, нарезаю снимки кнопок и контролов, обрабатываю их края и вставляю в проект, а затем пишу описания каждой выноски. На это тратится уйма времени и усилий.

Кое-что еще…

В Dr.Explain есть и другие полезные возможности, которых, к сожалению, нет в Help and Manual. Например, есть удобный режим просмотра проекта – одним кликом по соответствующей кнопке можно быстро посмотреть, как будет выглядеть справка в формате CHM или HTML после компиляции. Превью открывается прямо в окне редактора. Поверьте, это очень удобно. Однако нет PDF-превью – это минус. В Help and Manual чтобы посмотреть, как выглядит справка, нужно постоянно компилировать проект.

Также в программе есть возможность интегрировать контекстно-зависимую справку прямо в приложение (F1), управление деревом навигации, набор шаблонов оформления, поддержка CSS, возможность быстрого обновления документации при выходе новой версии программы путем замены иллюстраций, но с сохранением выносок, аннотаций, описаний; функция поиска и индексации в онлайн-справке без программирования (PHP, ASP) или баз данных на стороне сервера.

Резюме

Вот, пожалуй, и все основные моменты, о которых я хотел здесь рассказать. Краткий обзор Dr.Explain я хотел написать еще два месяца назад, когда впервые увидел программу, но потом отложил эту затею на неопределенное время. А недавно снова готовил справку пользователя в Help and Manual и еще раз убедился, что документировать интерфейс все же удобнее в Dr.Explain.

Источник

Работа, представленная на фестиваль

Электронное справочное руководство по информатике и ИКТ

Электронное справочное руководство представлено в формате HTML

Раздел:

Информатика

Учебный год: 2008 / 2009

Автор:
Довганина Ангелина Александровна

Руководитель:
Толстая Наталья Юрьевна

Материалы работы:

575003.zip
* (550 кБ)

Описание работы:

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

Технические требования:

OC Windows 98/NT/200/XP/Vista, Internet Explorer

Порядок знакомства:

Запустите файл index.html, который находится в папке SpIIKT

Контактная информация:

Эл. почта: dovangelina@mail.ru

* Для распаковки архива вы можете воспользоваться бесплатной программой 7-Zip или любой другой программой, поддерживающей архивы 7z и Zip.

Источник

Электронная справочная система доступна из интерфейса DICOM-Просмотрщика. Чтобы иметь
возможность использовать электронное руководство пользователя, необходимо отметить при
установке программы пункты Help->Assistant для нужных языков.

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

Язык интерфейса справочной системы совпадает с языком, установленным в операционной
системе.

19.1.1 Запуск электронного руководства пользователя

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

Через главное меню. Откройте меню «Справка» главного меню и выберите пункт
«Содержание…». Справочная система открывается на странице, содержащей
информацию об активной вкладке.
Через вплывающую подсказку. Наведите курсор на интересующую кнопку, чтобы
появилась всплывающая подсказка. Если данной кнопке соответствует страница
справочной системы, то в подсказке есть ссылка «Справка», при нажатии

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

Если справочная система уже запущена, то в ней открывается нужная страница.

Если для выбранного объекта интерфейса не задана страница, то справочная система
открывается на последней просмотренной в прошлый раз странице.

19.1.2 Настройка электронного руководства пользователя

По умолчанию стиль программы QT Assistant совпадает со стилем DICOM-Просмотрщика.
Чтобы отключить использование стиля DICOM-Просмотрщика снимите флаг «Использовать
выбранный стиль для справочной системы» (раздел 15.5).

Источник

Интерактивное электронное техническое руководство — это эксплуатационная, справочная или ремонтная документация, выполненная в интерактивной электронной форме.

В виде ИЭТР могут быть представлены:

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

Классический пример ИЭТР — «Электронное интерактивное руководство по эксплуатации на универсальный пульт машиниста УПУ-22», которое в «Иторум» разрабатывали совместно со специалистами ОАО «Демиховский машиностроительный завод». Для руководства были переработаны существующие и разработаны новые иллюстрации, поясняющие места установки составных частей конструкции. Для упрощения операций по управлению электропоездом наша команда анимировала порядок и правила выполнения нужных действий, а для самых сложных элементов пульта разработали интерактивный тренажер с ознакомительным режимом и курсом отработки типовых действий.

Эксплуатационные и ремонтные документы в формате ИЭТР могут включать:

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

Стандарты и ГОСТы ИЭТР

Разработка интерактивных электронных технических руководств (ИЭТР) выполняется в соответствии с требованиями зарубежных и отечественных нормативных документов.

ГОСТ 2.051-2006 «ЕСКД. Электронные документы. Общие положения».
ГОСТ 2.601-2013 «ЕСКД. Эксплуатационные документы».
ГОСТ 2.602-2013 «ЕСКД. Ремонтные документы».
ГОСТ 2.610-2006 «ЕСКД. Правила выполнения эксплуатационных документов».
ГОСТ 2.611-2011 «ЕСКД. Электронный каталог изделий. Общие положения».
ГОСТ 18675-2012 «Документация эксплуатационная и ремонтная на авиационную технику и покупные изделия для нее».
ГОСТ Р 54087-2010 «Интегрированная логистическая поддержка. Контроль качества и приемка электронных интерактивных эксплуатационных и ремонтных документов. Основные положения и общие требования».
ГОСТ Р 54088-2010 «Интегрированная логистическая поддержка. Интерактивные электронные эксплуатационные и ремонтные документы. Основные положения и общие требования».
ГОСТ Р 54090-2010 «Интегрированная логистическая поддержка. Перечни и каталоги предметов поставки. Основные положения и общие требования».

ASD S1000D «International specification for technical publications using a common source database»;
ATA iSpec 2200 «Information Standards for Aviation Maintenance».

Средства разработки

Для разработки ИЭТР используются Lattice 3D Studio, CorelDRAW Technical Suite X7, Technical Guide Builder (TG Builder) и другие системы: средства и инструменты подбираются в соответствии с требованиями Заказчика к функционалу.

Способы поставки

Готовые ИЭТР передаются Заказчику любым из трех способов:

На информационном носителе вместе со средством просмотра;
Через удаленный доступ к данным вместе со средством просмотра;.
С доступом через глобальную компьютерную сеть и функцией просмотра в стандартном интернет-браузере.

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

Цель нашей работы — повысить эффективность вашего бизнеса!

За счет креативных решений, инноваций и целеустремленности.

Отправить заявку