Что такое user guide

Что такое user guide

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

[Е.С.Алексеев, А.А.Мячев. Англо-русский толковый словарь по системотехнике ЭВМ. Москва 1993]

Тематики

  • информационные технологии в целом
  • user guide
  • manual

Англо-русский словарь нормативно-технической терминологии . academic.ru . 2015 .

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

user guide — UK US noun [countable] [singular user guide plural user guides] a document that tells you how to do something, for example how to use a computer program Thesaurus: computer files and documents and collections of computer data … Useful english dictionary

user guide — user ,guide noun count a document that tells you how to do something, for example how to use a computer program … Usage of the words and phrases in modern English

User guide — A user guide or user s guide, also commonly known as a manual, is a technical communication document intended to give assistance to people using a particular system.[1] It is usually written by a technical writer, although user guides are written … Wikipedia

user guide — UK / US noun [countable] Word forms user guide : singular user guide plural user guides a document that tells you how to do something, for example how to use a computer program … English dictionary

user guide — vartotojo žinynas statusas T sritis automatika atitikmenys: angl. user directory; user guide; user manual vok. Bedienungsanleitung, f; Benutzerauskunftsdatei, f; Benutzerhandbuch, n rus. руководство пользователя, n; справочник пользователя, m… … Automatikos terminų žodynas

user guide — vartotojo instrukcija statusas T sritis automatika atitikmenys: angl. user guide; user manual vok. Benutzeranleitung, f; Benutzerhandbuch, n rus. руководство для пользователя, n pranc. notice de présentation, f … Automatikos terminų žodynas

guide de l’utilisateur — vartotojo žinynas statusas T sritis automatika atitikmenys: angl. user directory; user guide; user manual vok. Bedienungsanleitung, f; Benutzerauskunftsdatei, f; Benutzerhandbuch, n rus. руководство пользователя, n; справочник пользователя, m… … Automatikos terminų žodynas

user directory — vartotojo žinynas statusas T sritis automatika atitikmenys: angl. user directory; user guide; user manual vok. Bedienungsanleitung, f; Benutzerauskunftsdatei, f; Benutzerhandbuch, n rus. руководство пользователя, n; справочник пользователя, m… … Automatikos terminų žodynas

user manual — vartotojo žinynas statusas T sritis automatika atitikmenys: angl. user directory; user guide; user manual vok. Bedienungsanleitung, f; Benutzerauskunftsdatei, f; Benutzerhandbuch, n rus. руководство пользователя, n; справочник пользователя, m… … Automatikos terminų žodynas

guide — guide1 W2S2 [gaıd] n ▬▬▬▬▬▬▬ 1¦(for deciding/judging)¦ 2¦(person)¦ 3¦(instructions)¦ 4¦(girl)¦ ▬▬▬▬▬▬▬ [Date: 1300 1400; : French; Origin: Old Provençal guida] 1.) ¦(FOR DECIDING/JUDGING)¦ somethin … Dictionary of contemporary English

guide — 1. noun /ɡaɪd/ a) Someone who guides, especially someone hired to show people around a place or an institution and offer information and explanation. b) A document or book that offers information or instruction; guidebook … Wiktionary

Читайте также:  Как сделать тест в гугл форме

разработка техдокументации — аванпроекты, НИР, ОКР — СРПП (ВТ), ЕСКД, ЕСПД, КСАС

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

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

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

Создан 11.02.2005 11:14:22

Когда умирает надежда, приходит отчаяние.

Мудрая латинская поговорка

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

Где взять структуру разделов руководства пользователя? С руководствами на изделия (руководство по эксплуатации по ГОСТ 2.601-95) и на автоматизированные системы (руководство пользователя по РД 50-34.698-90) все более или менее ясно. А вот сам документ «Руководство пользователя» программы в ГОСТах 19-й системы отсутствует как класс.

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

Цели и задачи статьи

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

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

Примечание от 10.07.2014 г. — В феврале 2005 года был проведен, пожалуй, даже не сравнительный анализ, а скорее сравнительные испытания, показавшие неоспоримое превосходство ГОСТов 19-й системы стандартов над буржуйскими и практически полную несостоятельность последних.

Вопросы, на которые должно дать ответы руководство пользователя

Подарите ребенку незнакомую ему электронную игрушку. Перечень вопросов будет примерно таким (если сразу же не разломает):

  • а что это;
  • а что им можно делать;
  • а что им нельзя делать (у особо одаренных);
  • а что надо, чтобы оно работало;
  • а что там у него внутри (у детей, склонных к глубокому анализу);
  • а как его настроить, чтобы работало так, как я хочу;
  • а как его проверить, работает оно или не работает;
  • а что и где надо нажимать;
  • а что оно еще может делать;
  • а что оно говорит, если что-то не так нажимаешь?
Читайте также:  Почему флешка на телефоне перестала работать

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

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

Крайняя четверка из перечня — эксплуатационные программные документы.

Возможно, существуют и иные документы, но автору, основательно порывшемуся в рунетовской свалке, ничего более подходящего заполучить пока не удалось. Яндекс обнаружил в своих недрах еще одну страничку с названием «Как сделать хорошее руководство пользователя», автор которой именует себя на американ Ьский манер (типа John P. Morgan). Двухстраничное «наставление» с радостными возгласами было немедленно отправлено в корзину.

Манифест Кагарлицкого

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

(цитаты из манифеста Кагарлицкого)

Мы стремились свести в единую систему всю совокупность типовых требований, которые должны, с нашей точки зрения, предъявляться к технической документации: руководствам, справочникам и т.д. При этом мы основывались на стандартах (. ) ГОСТ, стандартах компании Microsoft, опыте наших сотрудников и других разработчиков технической документации.

В состав технической документации входят две стержневые части, которые мы будем называть соответственно руководством пользователя и справочником пользователя, или коротко: руководством и справочником (по аналогии с английскими словосочетаниями User’s Guide и User’s Reference). Они могут быть оформлены в виде отдельных документов (для крупных программных продуктов), а могут, напротив, существовать в интегрированном виде. Между ними даже может не быть четкой границы: единый текст способен совмещать в себе черты руководства и черты справочника.

Что-то не так. Автору статьи всегда «казалось», что термин техническая документация трактуется более широко, значительно шире, чем эксплуатационная (программная) документация.

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

По-понятиям так по-понятиям, вот только пацаны начинают нервничать. Руководство не есть понятие, а есть вид документа.

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

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

Читайте также:  Спейсис вход на мою страницу

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

Жаль. А так все хорошо начиналось. Со «стандартов ГОСТ» — «стандартов ГОсударственных СТандартов» — простим г-на Кагарлицкого за тавтологию. Только вот решения первой задачи, поставленной автором настоящей статьи, в семидесятидвухстраничном манифесте (Arial’ом 12pt) нет. Уважаемый автор манифеста лишь поставил нам задачу. Что ж, нет пророка в своем отечестве. Может, есть пророк в отечестве буржуйском?

Руководство пользователя по IEEE Std 1063-2001 «IEEE Standard for Software User Documentation»

Забугорный «пророческий» документ IEEE Std 1063-2001 (IEEE в простонародье — «ай-яй-яй») в подразделе 1.2 (Puprose) содержит такую строчку:

This revision provides requirements for the structure, information content, and format of both printed and electronic documentation.

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

Структура руководства пользователя по IEEE Std 1063-2001

Опциональная типовая структура руководства пользователя содержится в таблице из раздела Structure of software user documentation документа IEEE Std 1063-2001:

User guide

Автор Ёветлана Антроцитова задал вопрос в разделе Программное обеспечение

что такое User Guide. в компьютере есть программа User Guide, что это такое и, что будет если ее удалить? Спасибо! и получил лучший ответ

Ответ от Виктор[гуру]
Свет.. . это очень просто.. . User Guide — дословно — Гид Юзера (т. е. пользователя) — это документ, программа или презентация к какому-то устройству или например, программе, позволяющие пользователю быстрее понять или освоить то, чем он пользуется. Еще у User Guide есть синонимы: мануал, справка, помощь. Если хотите, можете удалить — ничего страшного для компа не произойдет.
Удачи))
Нафаня
Мастер
(1393)
Не за что)) Светлана, Вы обращайтесь, если что, мне не трудно помочь..

Ссылка на основную публикацию
Что означает охват в статистике вконтакте
Что такое охват подписчиков во Вконтакте Как посмотреть охват? Для сообщества Перейдите в сообщество, на панели управления нажмите кнопку «Статистика»,...
Что делать если взломали сим карту
Подавляющее большинство современных телефонов оборудовано лотком под сим-карту, вытащить который очень легко с помощью скрепки или иглы. Какие-то телефоны после...
Что делать если забыл название игры
В сообществе Лига Геймеров очень часто всплывают посты "Помогите найти игру". Там их не очень жалуют. Для этого и создано...
Что означает ошибка esp
Однажды ни с того ни с сего во время достаточно спокойной езды загорелась ошибка: "Сервис: ESP", затем следом появилось сообщение...
Adblock detector