Руководства пользователя
CRM
28.10.2021
PDF,
130.61 КБ
28.10.2021
PDF,
578.83 КБ
17.05.2019
PDF,
949.02 КБ
16.06.2014
PDF,
744.07 КБ
Автобизнес: Автосалоны, Автотехцентры
Гостиничный бизнес
10.08.2022
PDF,
146.21 КБ
23.06.2022
PDF,
262.87 КБ
23.06.2022
PDF,
250.98 КБ
23.06.2022
PDF,
925.64 КБ
Здравоохранение
26.07.2018
DOCX,
138.88 КБ
Инвестиционные и управляющие компании
28.10.2021
PDF,
506.47 КБ
28.10.2021
PDF,
849.71 КБ
28.10.2021
PDF,
399.28 КБ
28.10.2021
PDF,
848.93 КБ
28.10.2021
PDF,
988.76 КБ
28.10.2021
PDF,
364.33 КБ
28.10.2021
PDF,
409.56 КБ
28.10.2021
PDF,
1018.84 КБ
Нефтебазы, АЗК
Ресторанный бизнес и общепит
01.10.2020
PDF,
895.72 КБ
02.06.2014
PDF,
1018.13 КБ
Розничная торговля
18.11.2022
PDF,
593.92 КБ
18.11.2022
PDF,
312.38 КБ
18.11.2022
PDF,
283.08 КБ
30.05.2016
PDF,
292.88 КБ
30.05.2016
PDF,
295.45 КБ
Транспорт, Логистика
30.10.2019
PDF,
621.18 КБ
Инструкция по настройке интеграции конфигураций «1С:Управление автотранспортом Проф», «1С:Транспортная логистика, экспедирование и управление автотранспортом КОРП» и «1С:Модуль 1С:Управление автотранспортом для 1С:ERP Управление предприятием, редакция 2
Управление мобильной связью
04.12.2020
PDF,
925.98 КБ
04.12.2020
PDF,
370.49 КБ
04.12.2020
PDF,
515.56 КБ
Аптеки и аптечные сети
20.01.2023
PDF,
153.27 КБ
Микрофинансовые организации и кредитные потребительские кооперативы (МФО, КПК)
28.10.2021
PDF,
849.26 КБ
28.10.2021
PDF,
566.06 КБ
Финансовый менеджмент
31.12.2020
PDF,
627.95 КБ
23.04.2020
PDF,
180.63 КБ
Ресторанный бизнес и общепит
30.08.2022
PDF,
497.67 КБ
30.08.2022
PDF,
262.95 КБ
Руководства пользователя
24.02.2014
PDF,
960.31 КБ
Шаблоны файлов помощи, руководства пользователя программного обеспечения или сайта, шаблон базы знаний — бесплатные шаблоны и примеры пользовательской документации
Журавлев Денис
Как разработать и написать хорошее руководство пользователя, если вы не технический писатель?
Готовые к использованию примеры и образцы пользовательской документации от разработчиков Dr.Explain — инструмента для быстрого создания руководств пользователя, файлов помощи, онлайн-справки.
Почему мы создали бесплатные шаблоны руководства пользователя
Мы развиваем проект Dr.Explain — программу для быстрого создания пользовательской документации, уже более пятнадцати лет. За это время мы накопили колоссальный опыт в этой области и очень хорошо изучили потребности людей, перед которыми встает задача создать руководство пользователя, файл справки или онлайн-инструкцию.
Много общаясь с нашими пользователями, мы поняли их ключевую боль. Она заключается в том, что даже самый удобный инструмент для разработки документации, не освобождает их от самой сложной, трудоемкой и, не будем скрывать, рутинной части проекта — непосредственной разработки и написания этой самой документации.
Несмотря на четкое понимание необходимости и реальной пользы от качественной документации, у большинства людей отсутствует желание заниматься ее написанием. Особенно, если техническое писательство не является их основной специальностью. Не секрет, что создание пользовательской документации часто поручают разработчикам, тестировщикам, менеджерам проекта, бизнес-аналитикам, специалистам технической поддержки. Иногда этим занимаются технические руководители проектов или даже директора компаний.
Вторая проблема при написании документации — отсутствие опыта и непонимание, с чего начать свой проект, как его структурировать, по какому процессу пойти. Именно поэтому большинство людей, столкнувшихся с необходимостью разработать руководство пользователя, первым делом забивают в поисковую строку Google или Yandex термин «пример руководства пользователя» или «шаблон руководства пользователя».
Мы также получаем похожие запросы от пользователей Dr.Explain. Они регулярно спрашивают нас с чего начать и можем ли мы поделиться образцом или хотя бы готовой структурой руководства пользователя программного обеспечения или web-сервиса.
Получается, что запросы наших пользователей полностью совпадают с нашими возможностями и экспертностью. В этой ситуации естественным решением было предложить всем, кто впервые столкнулся с задачей самостоятельной разработки документации к своему программному обеспечению, web-сервису или технической системе, готовые типовые шаблоны и образцы руководства пользователя, которые можно взять за основу и быстро адаптировать под свой проект.
Руководствуясь этим, мы добавили в Dr.Explain готовые шаблоны типовых проектов. На данный момент в пакет включены следующие шаблоны:
- Руководство пользователя программного обеспечения.
- Руководство пользователя web-сервиса.
- Корпоративная база знаний компании.
В чем удобство создания руководства пользователя по образцу
Экономия времени.
Используя готовый шаблон документации, вы значительно экономите время на создание структуры проекта с нуля и на поиск и изучение информации о том, как это делается. Шаблон содержит не только готовую структуру в виде дерева типовых разделов.
Фокус на вашем продукте, а не на структуре документации.
Само содержание разделов уже частично заполнено текстовым и графическим контентом, предлагая вам сразу приступить к вводу информации именно о вашем продукте, а не думать о форме ее подачи.
Практическая демонстрация приемов работы в Dr.Explain.
Примеры и шаблоны руководств пользователя созданы и с использованием текстовых переменных и преднастроенных стилей оформления. Это позволит вам сразу понять, как можно использовать эти механизмы для быстрой разработки пользовательской и справочной документации в Dr.Explain.
Бесплатность.
Шаблоны руководств пользователя и базы знаний, встроенные в Dr.Explain можно свободно использовать даже в бесплатном режиме программы. Вы можете модифицировать и дорабатывать свой проект сколь угодно долго без функциональных ограничений. При использовании бесплатной лицензии на имеющиеся изображения при финальном экспорте будет добавлен водяной знак, но даже с ним ваша документация может быть использована в демонстрационных и даже рабочих целях.
Возможность модификации под специфику своего проекта.
Предлагаемые шаблоны руководств пользователя в программе Dr.Explain являются лишь экспертной рекомендацией, обобщающей наш многолетний опыт работы области технического писательства. Структура и содержание разделов в шаблонах не являются абсолютными или строго обязательными по какому-либо утвержденному стандарту. Вы можете свободно модифицировать шаблоны под специфику вашего программного продукта. Это позволяет использовать образцы в различных бизнес-направлениях — от инженерных областей, до образования, медицины, науки, сферы финансовых и потребительских услуг.
О структуре шаблонов
Проанализировав за 15 лет сотни пользовательских руководств, мы поняли какие типовые разделы могут подойти большинству проектов и включили их в наши шаблоны. Далее расскажем из каких блоков состоят шаблоны и для чего они служат.
Обзор возможностей программ. В данном разделе принято описывать для чего и для кого создана программа, какие задачи она позволяет решать и какую выгоду пользователи от этого получат. В разделе также можно указать системные требования программы.
Пользовательский интерфейс. Этот раздел позволит пользователю ознакомиться с интерфейсом программы: окна, экраны, режимы, предназначение различных управляющих элементов. Также в нём можно указать информацию о настройках и параметрах программы.
Типовые задачи. Этот блок предназначен для детальногоознакомления пользователя с тем, что умеет ваша программа и как она работает. В шаблоне он состоит он из двух разделов. Раздел «Примеры использования» описывает какие задачи стоят перед пользователем и как программа их решает. Другими словами — типовые ситуации, с которыми сталкиваются пользователи. «Лучшие практики» -здесь предлагается указывать информацию о том, как можно максимально быстро и эффективно пользоваться продуктом.
Особые случаи. В разделах этого блока можно найти ответы на частые вопросы, описания проблем и путей их решения. Разделы: «FAQ» и «Устранение типовых проблем»
Вспомогательная и юридическая информация. В этот блок включены:лицензионное соглашение и контактная информация,в которую входят сведения о компании: сайт продукта, контактные данные технической поддержки, информация о сотрудничестве и прочее.
Как работать с шаблонами документации в Dr.Explain
Чтобы начать работу с шаблонами и создавать пользовательские руководства — скачайте программу Dr.Explain:https://www.drexplain.ru/download/
При установке программы в качестве основного языка интерфейса необходимо выбрать русский.
При открытии программы на главном экране выберите один из интересующих вас шаблонов: (Руководство пользователя ПО, Руководство пользователя Web-сервиса, Корпоративная база знаний). Они находятся в разделе «недавние проекты»
В свойствах проекта измените значения текстовых переменных на свои. Переменные используются когда нужно многократно вставить один и тот же фрагмент текста.
В предлагаемых шаблонах в переменные оформлены имя продукта, версия и название компании. Вы можете по необходимости создавать дополнительные переменные.
Далее дозаполните разделы руководства своей информацией и модифицируйте документацию под свой проект.
Настройте вывод вашей документации в различные форматы (HTML, CHM, PDF)
Дополнительные шаблоны и образцы документов
Основываясь на своем опыте и опыте общения с нашими клиентами, мы подготовили шаблоны для самых распространенных случаев, с которыми сталкиваются IT-компании при разработке пользовательской документации. Надеемся, что наши шаблоны с высокой долей вероятности помогут и вам.
Если вы считаете, что в программе не хватает нового специфического шаблона и он может быть полезен многим пользователям, мы готовы разработать такой шаблон. Пожалуйста опишите вашу задачу и поделитесь своими мыслями, шаблон какого документа был бы полезен для вас. Ждем ваших писем на: help@drexplain.com
Смотрите также
- Как написать руководство пользователя программы или сайта — инструкции, советы, помощь, программное обеспечение
- Создание руководства пользователя по ГОСТ 19 и 34 по шаблону с примерами оформления и образцами в приложении Dr.Explain
программного
обеспечения
Блок управления
манипулятора «Скамко-1»
Содержание
1.
Описание программного обеспечения
1.1. Программа
«Система управления робота Скамко-1»
(ckamko.exe)
1.2 Система команд
интерпретатора.
1.3 Команды движения
1.4 Модуль драйвера
порта
1.5 Пульт ручного
управления
2. Протокол обмена
между ПК и блоком управления
3. Алгоритмы ПО
приводного уровня.
3.1 Алгоритм основного
цикла программы
3.2 Алгоритм обработки
сервисных команд
3.3 Алгоритм
управления работой привода
3.4 Алгоритм режима
калибровки с помощью концевых датчиков
3.5 Алгоритм
разгона/торможения привода
4. Инструкция по
прошивке микроконтроллеров Atmega128
и Atmega8
1.
Описание программного обеспечения
1.1. Программа
«Система управления робота Скамко-1»
(ckamko.exe)
Программа «Система управления робота
Скамко-1» (файл ckamko.exe)
представляет собой интерфейс верхнего
уровня системы управления робота.
Она предназначена для организации
взаимодействия СУ с пользователем и
позволяет:
-
Обеспечивать связь между компьютером
с операционной системой WindowsXPи контроллером управления
приводами и технологического оборудования. -
обеспечивать связь с вышестоящим
уровнем системы управления по сети -
обеспечивать связь с системой технического
зрения -
осуществлять непрерывную диагностику
приводов манипулятора -
контролировать текущие координаты
всех звеньев манипулятора и его схвата -
обучать робот точкам
-
решать прямую и обратную кинематические
задачи в целях управления роботом в
позиционном и контурном режимах.
В ее состав вошли:
-
Интерпретатор робото-ориентированного
языка на основе Javascript -
Модуль драйвера COM-порта
-
Пульт ручного управления
-
Модуль для работы с файлами
Ядро программы представляет интерпретатор
робото-ориентированного языка
программирования. Разработанный мною
язык программирования базируется на
языке Javascriptи поэтому
подчиняется всем правилам, которые ему
присущи. Мною был разработан набор из
17 макрокоманд, доступных пользователю.
Синтаксис макрокоманд похож на синтаксис
языкаARPS, что делает
обучение пользователя, знакомого с ним,
работе с языком программирования робота
«Скамко-1» очень быстрым.
Скриптовые языки одним из которх является
Javascriptработают с системными
функциями черезCOMавтоматизацию (COMAutomation), поэтому мною был
созданCOMсерверControlcодним интерфейсом,
содержащим 17 методов (method)
и несколько служебных свойств (property).
Для того чтобы подключиться к серверу
автоматизацииJasvasriptиспользует функцию ActiveXObject(), передавая
ей ProgID сервера. Для запуска файла *.jsиспользуется программаWinScript,
входящая в состав операционной системыWidowsXP. Это
позволяет отслеживать завершение
одноименного процесса операционной
системы, а соответственно и выполнения
скрипта. Запуск набранной пользователем
программы осуществляется по схеме,
упрощенно показанной на рисунке 1.
Рис 1
Файл functions.lstсодержит описание макро-команд обращения
к интерфейсным функциям сервераControl.
Набор описаний может быть расширен при
доработке языка программирования и
расширения его системы команд. Структуру
макро-описания рассмотрим на примере
командыGO( ). Входным
параметром является структура типаPOINT, которая задается
командойPOINT(X,Y,Z,PHI),
гдеX,Y,Z,PHI– это соответственно
координаты и ориентация схвата в
декартовой системе координат. Кроме
того, структураPOINTдополняется еще 10 полями при использовании
локальной системы координат, речь о
которой пойдет ниже.
Пример описания макрокоманды:
functionGO(pt)
{
if (pt.using_frame != 111)
{
server.Go(pt.x, pt.y, pt.z, pt.orient);
}
else
{
server.Go_Frame(pt.x, pt.y, pt.z, pt.orient, pt.x1, pt.y1,
pt.z1, pt.x2, pt.y2, pt.z2, pt.x3, pt.y3, pt.z3);
}
}
Сначала идет ключевое слово function,
говорящее о том, что текст заключенный
в фигурные скобки, представляет собой
описание макрофункции. Затем идет
название функцииGOи
ее входной параметрpt.
По значению поляusing_frameструктурыpointинтерпретатор
определяет, является ли эта точка
заданной в глобальной системе координат,
или она задана в системе координат
какого-либо фрейма. Если точка задана
в глобальной системе координат, то
следует вызов методаGoсервера автоматизации. Описание
методов находится
в файле
CONTROLIMPL.СPP ( Implementation of
TControlImpl (CoClass: Control, Interface: IControl) ). Если
значениеusing_frameустановлено в111, то точка задана в
локальной системе координат фрейма,
поэтому вызывается другой метод –Go_Frame. Его
входные параметры кроме координат и
ориентации схвата содержат координаты
трех точек, по которым составляется
фрейм.
Интерфейс пользователя представлен на
рисунке 2
Рис 2
Команды вводятся пользователем с
клавиатуры в окне «Text».
При этом должны быть соблюдены определенные
правила, называемые синтаксисом языка.
Каждая новая команда и вообще ключевое
слово должны вводиться с новой строки.
В конце строки должна ставиться точка
с запятой(;).
После того как программа набрана и
нажата кнопка «Выполнить» программа
проверяет синтаксис текста. Если
встречается ошибка, то ее код и содержание
выдается пользователю в всплывающем
окне, которое генерирует JavaScript.
В настоящее время коды ошибок не
расшифровываются, однако это легко
реализовать, воспользовавшись механизмом
«исключений» (exception),
которые генерирует операционная системаWindowsXPи
программаWinScriptв частности.
Из-за того, что манипулятор «СКАМКО» не
обладает датчиками положения текущее
положение сочленений неизвестно. Поэтому
предлагается прежде чем перемещать
схват в нужную точку выполнить операцию
калибровки. Данная задача реализована
командой “CALIBRATE()”.
Встречая этот оператор, интерпретатор
выдает команду на калибровку системы
управления, а после получения отчета о
выполнении, осуществляет перемещение
всех звеньев в нулевое (домашнее)
положение. После этого продолжается
разбор следующих команд.
Соседние файлы в папке Документация по СКАМКО
- #
- #
- #