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

5 программ для создания групповых заметок, документации к API и руководства пользователя

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

1. Paper Dropbox

Так выглядит страница «обзора проекта» в программе. Изображение: скриншот с сайта paper.dropbox.com

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

После сервис предложит вам выбрать шаблон документа: мозговой штурм, обзор проекта, конспект собраний, но вы можете создать и свой новый документ. Я выбрала «обзор проекта» и пригласила нескольких друзей.

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

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

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

 Ссылки на некоторые сайты превращаются в виджеты.

А еще есть чат и совместная работа, где вы можете создавать списками задания, делегировать задачи и контролировать выполнение (отметить ответственного пользователя просто – с помощью @).

У сервиса есть приложение для смартфонов на Android и iOS.

Сайт Paper Dropbox

Еще по теме: 5 бесплатных приложений для заметок

2. Process Street

Пример чек-листа, созданного в программе. Изображение с сайта app.process.st

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

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

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

А прогресс можно отслеживать в специальном разделе.

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

Есть бесплатный тариф, на котором количество пользователей не ограничено. Платные тарифы начинаются от 12,5$ в месяц.

Сайт Process Street

3. Dr.Explain

Пример руководства, созданного в программе. Изображение: скриншот с сайта www.drexplain.ru

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

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

Вы можете добавить небольшое пояснение к каждой выноске.

Для начала работы вам нужно просто указать веб-страницу сервиса, который нужно описать. Любой проект можно импортировать в программу (если вы, например, работали в другом приложении). Поддерживает документы в CHM, Word, HTML, HLP, RTF, TXT, XML.

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

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

Cайт Dr.Explain

4. Apiary

Пример шаблона документации. Изображение с сайта apiary.io

На создание API документации можно потратить уйму времени: нужно описать множество деталей для вашего потребителя. Программа как раз помогает создавать документацию к API (Application Programming Interface – это интерфейс программирования, интерфейс создания приложений или, другими словами, готовый код).

Все ваши документы будут создаваться на специальном предметно-ориентированном языке (DSL). Затем при помощи прокси к API можно написать запросы, чтобы проверять, что все описанное соответствует действительности.

Особенно подходит для тех, кто размещает свои it-проекты Github, потому что сервис обеспечивает бесплатную синхронизацию с хостингом.

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

Сайт Apiary

5. Read the Docs 

Пример документации на сервисе. Изображение с сайта gef.readthedocs.io

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

Документацию из проекта можно импортировать с помощью систем контроля версий: Mercurial, Git, Subversion и Bazaar.

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

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

Вот один из примеров русскоязычной документации под названием «Руководство пользователя базовой геоинформационной платформы КОСМОС».

Визуально документ выглядит четко структурированным, аккуратным, есть кнопки навигации (previous, next), встроенные в разделы. Можно использовать поиск по всему документу.

Наглядное меню помогает читателю ориентироваться в руководстве.

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

Сайт Read the Docs

Источник: https://te-st.ru/entries/5-programs-to-create-a-group-of-notes/

Функциональные характеристики Master PDF Editor

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

Возможности программы включают в себя полную поддержку PDF файлов, импорт/экспорт PDF страниц в форматы изображений, преобразование XPS в PDF и 128-битное шифрование.

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

Открытие и просмотр PDF файлов

• Открытие документов PDF для просмотра, печати, заполнения форм, редактирования всех объектов и сохранения сделанных изменений.
• Открытие PDF документа в формате XFA для просмотра, заполнения форм и печати.
• Просмотр документов, защищенных паролем (требуется ввести пароль)
• Настройка параметров просмотра документа (выбор вида страницы, поворот страницы, отображение для просмотра одной или двух страниц одновременно, полноэкранный режим и др.)
• Поиск текста в документе, включая комментарии (с учетом регистра, только целые слова)
• Навигация по документу (переход к определенной странице, переход с помощью закладок, переход при помощи миниатюр страниц)
• Копирование текста, изображений, форм и других объектов.
• Просмотр вложенных файлов. Их добавление, переименование, удаление.
• Отправка PDF файлов по email с используя интерфейс программы (GUI)
• Отправка по ftp, http(s), email с использованием JavaScript
• Печать PDF документа с широкими настройками (печатать только документ, печатать документ и аннотации и др.)
• Гибкая настройка внешнего вида как самой программы так и структуры просматриваемых документов с изменением цвета, шрифта и фона документа. Используется для удобства чтения PDF книг.

Редактирование документов PDF

• Добавление, редактирование, удаление, замена и форматирование текста в документе
• Преобразование изображения текста PDF в редактируемый текстовый формат
• Создание, редактирование, удаление форм, и управление ними. Настраиваемые действия с формами
• Добавление, удаление и редактирование гиперссылок и управление ними. Настраиваемые действия для гиперссылок
• Копирование и вставка графических объектов и изображений. Их перемещение, выравнивание, удаление и др.
• Вставка скопированных объектов на нескольких страницах одновременно
• Добавление, редактирование, удаление водяных знаков, фона, колонтитулов в документ. Настройка параметров данных объектов.
• Редактирование содержимого контейнера
• Создание, перемещение, удаление и изменение закладок. Настраиваемые действия с ними.
• Удаление контура обрезки
• Управление страницами документа (вставка, извлечение, удаление, изменение порядка, изменение размера, обрезка, поворот, и др.)
• Вставка страниц текущего документа в другой PDF файл
• Экспорт PDF в изображение
• Экспорт PDF в текстовый формат
• Экспорт и импорт страниц, включая закладки
• Функция оптимизации PDF файлов (с помощью преобразования рисунков JPG и JBGI2, удаление неиспользуемых элементов, преобразование всех форм и комментариев в векторные рисунки)

Редактирование свойств документа и/или его отдельных страниц

• Изменение свойств документа (такие как название, сведения о документе, автор и др.)
• Изменения свойств документа, которые настраивают его внешний вид при открытии
• Создание JavaScript, который выполняется при открыти документа,
• Создание JavaScript, который выполняется перед закрытием, перед сохранением, после сохранения, перед печатью, после печати документа.
• Создание JavaScript для каждой страницы, которые выполняются перед и/или после просмотра страницы

Системные требования:

Microsoft Windows:
XP (Service Pack 3), 2003, 2008, Vista, 7, 8, 10 (32 & 64 бит)

Linux:Для версии с Qt4 — требования: Qt 4.6.2 и выше, glibc 2.12 и выше (32 & 64 бит)

Для версии с Qt5 — требования: Qt 5.41 и выше, glibc 2.19 и выше (только 64 бит)

macOS:
Версия 10.7.5 и выше 64 бит.

Источник: https://code-industry.ru/masterpdfeditor-help/

Обзор Help&Manual — программы для создания файлов справочной системы

Итак, вы создали программное обеспечение, которое собираетесь продать и неплохо на этом заработать. Программа, скомпилирована, отлажена и протестирована. Единственное, чего ей не хватает, — это файла помощи.

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

В этом обзоре будет рассмотрена программа Help&Manual от компании EC Software, способная генерировать help-файлы самых различных форматов.

Главным преимуществом программы является ее универсальность.

С ее помощью можно получить файл справочной информации в любом из наиболее распространенных на сегодняшний день форматов (CHM, HLP, HXS, HTML, PDF, RTF, EXE, XML).

Интуитивно понятный интерфейс делает программу простой в освоении. Основной блок программы составляет текстовый редактор, мало отличимый от MS Word как по интерфейсу, так и по количеству возможностей.

Интерфейс программы

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

В дереве задается вся структура файла содержания, так как его будет видеть пользователь. Здесь задаются заголовки папок и страниц.

Для каждого элемента дерева можно задать собственную иконку и статус.

В зависимости от статуса элемент выделяется своим цветом (желтый — редактируется, голубой — требует доработки, белый — готов), тем самым делая работу по наполнению страниц более наглядной.

Редактор страниц состоит из трех закладок: Topic Options (опции), Page Editor (редактор страницы), XML Source Code (исходник в формате XML).

Главное окно программы

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

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

Третья закладка – это исходный текст страницы в формате XML. При желании пользователь имеет возможность редактировать страницу прямо в исходнике или добавлять сюда код, который невозможно ввести с помощью редактора (хотя такое трудно себе представить).

Рассмотрим некоторые важные инструменты редактора.

Якоря

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

Все ключевые слова, указанные как целиком для страниц, так и для якорей, будут выводиться на странице «Указатель (Предметный указатель, Index) сгенерированных файлов помощи».

Щелкнув по выбранному ключевому слову, будет осуществлен переход к объекту, на который то ссылается: страницу или якорь.

Окно добавления якоря

Гиперссылки

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

• Ссылки на страницы текущего файла помощи. Для этого случая в параметрах ссылки указывается идентификатор страницы, на которую будет осуществлен переход. Если перейти нужно не к началу страницы, а к якорю на ней, дополнительно указываем идентификатор этого якоря. Если в программе определено более чем одно окно, здесь можно указать, какое из окон будет открываться при переходе по ссылке. Окно добавления гиперссылки
• Интернет-ссылки. В этом случае здесь указывается адрес страницы или электронной почты. Для первого варианта можно задать, в каком окне страница будет открываться: в том же или в новом (имеет значение только для файлов CHM, HTML и XML). Причем адрес должен быть полным (например, http://www.yandex.ru , а не www.yandex.ru). Для второго варианта будет создаваться электронное письмо с исходящим адресом, указанным в ссылке.
• Ссылки на файлы. Указывается файл, который будет открываться при переходе по ссылке.
• Ссылка на скрипт. Для этого случая в параметрах ссылки пишется выполняемый скрипт или макрос.

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

Условия

Если есть необходимость добавить в проект текстовый блок, который должен отображаться только в избранных форматах файлов помощи, то на помощь придет инструмент «Условие».

Окно добавления условия

В параметрах этого инструмента выбираются форматы компилируемых файлов и ставится логическое условие IF, IFNOT или ELSE (если, если не, иначе). После применения этого инструмента выделенный текстовый блок заключается в красные маркеры.

Текстовые переменные

В параметрах проекта можно задать несколько предопределенных параметров, таких как заголовок, автор, копирайт, номер версии и т. д.

Эти параметры можно выводить на страницах с помощью текстовых переменных.

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

Окно добавления текстовой переменной

Источник: https://www.ixbt.com/soft/help-and-manual.shtml

Выпуск №87. Создание инструкций

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

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

О правилах создания тех и других сегодня пойдет речь.

Текстовые инструкции

Руководство пользователя должно отвечать на три основных вопроса: «Что?», «Зачем?», «Почему?», то есть раскрывать суть, объяснять специфику и возможные причины.

Поданная информация должна показать все возможности товара и таким образом донести разнообразие функций пользователю.

Инструкция является важным показателем отношения к клиенту.

Правила по тексту

• Пишите по сути, избегая сложных конструкций в предложениях.
• Откажитесь от прилагательных.
• Повелительная форма – лучший способ донести информацию.
• Абзацы делайте короткими.
• Избегайте списков, подавая пункты в предложении через запятую.
• Старайтесь действие и его объяснение подавать в разных абзацах.
• Перед каждой главой делайте небольшое вступление, где будет описана ее суть.
• Структура глав должна быть максимально похожей.

Правила по форме

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

Советы

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

-инструкции

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

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

Многое зависит от того, для какого продукта снимается инструкция, будет ли кто-то в кадре, как организовано освещение и т.п.

Основные правила

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

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

Скринкастинг: запись действий с рабочего стола

Если стоит задача объяснить специфику использования программного обеспечения, лучше использовать программы записи действий с компьютера. Такую возможность рассмотрим на примере одной из программ – Movavi Screen Capture Studio для Windows или Mac. Одна из ее функций – запись всех ваших действий с экрана.

Алгоритм работы

1. Скачать программу и запустить дистрибутив.
2. Установить настройки записи: захват видео и эффекты.
3. Выбрать параметры звука: динамики компьютера или ваши комментарии посредством микрофона.
4. Уточните область, которая должна быть отражена на видео.
5. Нажмите кнопку REC для записи, при необходимости используйте кнопки Пауза или Стоп.
6. Сохраните видео, предварительно конвертировав в нужный формат.
7. Распространите ролик на , или Vimeo через эту же программу с помощью кнопки Share Online.

По такому же принципу работает программа Camtasia Studio и Camtasia for Mac. Происходит захватывание видео с экрана по установленным вами параметрам. Здесь также можно записать звук с микрофона или динамиков, а также разместить видеоролик с веб-камеры с возможностью последующего редактирования.

Аналоги

Screencast-O-Matic. Бесплатна и позволяет опубликовать видео длительностью до 15 минут на бесплатном хостинге. На готовом видео будет водяной знак компании.

UvScreenCamera. Существует платная и бесплатная версии. В наличии многофункциональный редактор. Платная версия имеет пробный период в 14 дней. Бесплатная версия ограничивает количество форматов и добавление аннотаций.

Бесплатная версия позволяет записывать всего 30 секунд, накладывает водяные знаки и создает скриншоты исключительно в растровом формате.

Стоимость платной версии – 29.95$.

Скриншоты

Источник: https://www.setup.ru/client/subscription/241