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

Обзор полезных сервисов для совместной работы над документами: от списков задач до объемных пользовательских руководств. Изображение с сайта pexels.com (CC0).
Изображение с сайта pexels.com (CC0 Обзор полезных сервисов для совместной работы над документами: от списков задач до объемных пользовательских руководств. Изображение с сайта pexels.com (CC0).

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

1. Paper Dropbox

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

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

У программы интуитивный и понятный интерфейс, с приятным дизайном. Очень удобно организовывать заметки: есть папки, отметки «Избранное», поиск и лента с изменениями во всех совместных документах, отсортированная в хронологическом порядке.

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

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

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

Сайт Paper Dropbox

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

2. Process Street

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

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

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

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

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

Сайт Process Street

3. Dr.Explain

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

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

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

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

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

Cайт Dr.Explain

4. Apiary

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

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

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

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

Сайт Apiary

5. Read the Docs 

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

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

Документацию из проекта можно импортировать с помощью систем контроля версий: Mercurial, Git, Subversion и Bazaar. Программа поддерживает webhooks, так что вы можете обновлять документацию сразу же после добавления в хранилище нового кода. В настройках управления проектом в разделе «Админ» можно изменить настройки проекта, например, добавить новые версии документации, назначить кураторов.

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

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

Сайт Read the Docs