User guide что это за программа и нужна

кнопка назад не работает Очень классное приложение
Отличная идея
Надеюсь что в процессе получения обратной связи от пользователей
Все ошибки программы исправите
Главное бороться и победить
Так кажется говорили люди в будёновках

Валерий2021 , 31.01.2021

Дом Зингера

Приложение классное , только не понял почему на панораме 1917 года красуется доходный дом стоявший на этом месте до этого, а не дом Зингера, построенный в 1904 году.

Анфиноген , 30.10.2020

Отличное приложение!

Начну с перевода инструкции и полного описания по использованию USB-тестера FNB48 от FNIRSI. Перевод выполнен и предоставлен автором CyJLTaH.
Ссылка на архив с DOC файлом — fnb48-russian-manual-v0.6.zip [ 2,86 Mb ] ( загрузок: 406 )
Обзор с тестами — ссылка и обзор модуля Bluetooth

Лечение гриппа, ОРВИ и простуды: простые советы. Нужно ли пить антибиотики или таблетки от гриппа

Инструкция к тестерам батарей от ZKEtech, описание ПО и что очень важно, описание калибровки.
Английский вариант — eb-tester-software-user-manual-v1.8.5.zip [ 700,28 Kb ] ( загрузок: 63 )
Русский вариант — eb_software_manual_ru.zip [ 497,84 Kb ] ( загрузок: 216 )
Обзоры
EBC-A10
EBC-A10H
EBC-A20
EBC-A40L
EBC-X 0510

Инструкция к LCR-метру XJW01.
Вариант на русском языке, за перевод и адаптацию спасибо автору NickNI — quick_user_guide_diy_digital_bridge_v3-01-ru.zip [ 795,1 Kb ] ( загрузок: 102 )
Исходный вариант на китайском языке — 0.3-precision-mr.-xus-digital-bridge-lcr-tester-resistance-inductance-capacitance-esr-table-product-kit.zip [ 2,16 Mb ] ( загрузок: 19 )
В блоге есть полный обзор с описанием замены дисплея на VATN и дополнительно описание установки в корпус с доработкой для аккумуляторного питания

Инструкция к частотному инвертору JFD-S ZW-S2015 серии JFD-S
Русскоязычный вариант от tuz_83 (спасибо ему) — jfd-s-rus.zip [ 1,08 Mb ] ( загрузок: 42 )
Второй вариант от другого автора, предположительно Chiaka — jfd-s-zw-s2015-rus.zip [ 1,38 Mb ] ( загрузок: 28 )
Исходный китайский вариант — jfd-s-china.zip [ 5,1 Mb ] ( загрузок: 15 )
Исходный английский вариант, переведен с китайского — jfd-s-manual-eng.zip [ 663,8 Kb ] ( загрузок: 15 )

Инструкция к генератору UNI-T UTG932E и UTG962E, авторский перевод от Polf за что ему большое спасибо — utg900e-russkaya-instrukciya.zip [ 1,37 Mb ] ( загрузок: 181 )

Источник: www.kirich.blog

ХауТу: Что такое NFC и как платить смартфоном?

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

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

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

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

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

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

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

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

- Как писать руководство пользователя 1

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

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

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

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

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

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

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

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

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

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

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

  • «метагайдом» Кагарлицкого;
  • суперсовременным IEEE Std 1063-2001, «IEEE Standard for Software User Documentation»;
  • классическими отечественными ГОСТами 19-й системы, включающим в себя перечисленные ниже документы «описательного» характера:
  • ГОСТ 19.402-78 ЕСПД. Описание программы;
  • ГОСТ 19.502-78 ЕСПД. Описание применения. Требования к содержанию и оформлению;
  • ГОСТ 19.503-79 ЕСПД. Руководство системного программиста. Требования к содержанию и оформлению;
  • ГОСТ 19.504-79 ЕСПД. Руководство программиста. Требования к содержанию и оформлению;
  • ГОСТ 19.505-79 ЕСПД. Руководство оператора. Требования к содержанию и оформлению.

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

Возможно, существуют и иные документы, но автору, основательно порывшемуся в рунетовской свалке, ничего более подходящего заполучить пока не удалось. Яндекс обнаружил в своих недрах еще одну страничку с названием «Как сделать хорошее руководство пользователя», автор которой именует себя на американЬский манер (типа 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:

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

Рейтинг
( Пока оценок нет )
Загрузка ...
EFT-Soft.ru