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