Как правильно составить help

Константин Вяткин
26.11.2000
Недавно один мой знакомый принес свою программу. Принес, по его словам, «уже готовую». И действительно, InstallShield, англоязычный интерфейс и прочие вещи намекали на полную готовность к выходу в люди. Поигравшись несколько минут с окошками, я нажал F1 — реакции не последовало… Увидев мой недоумевающий взгляд, приятель быстро сориентировался и изрек: «А хелпа нету! Зачем он здесь нужен — у меня же интуитивно понятный интерфейс, понимаешь!»

Зачем нужен Help

Справочная система — это, пожалуй, та грань, которая отделяет «поделку для друзей» от программы, предназначенной для публичного распространения. Широко распространенная шутка по поводу того, что какая-то программа работает только в присутствии программиста, ее написавшего, берет свое начало от нелюбви разработчиков к написанию грамотной, полезной и удобной документации для своих творений. Пользователи обычно гораздо менее сообразительны и образованны, чем вы предполагаете. Более того, если программа ориентирована на российский рынок, помните, что в большинстве случаев наши люди хелпов не читают (причем не читают даже перед тем, как обратиться к автору программы с вопросом — в отличие от большинства иностранцев), и лишь немногие из пользователей отважатся прочитать первую страницу вашего литературного творчества. Но, тем не менее, help программе в любом случае нужен — вопрос только, в каком виде?

Какие бывают хелпы

Перефразируя известную народную мудрость, можно сказать, что иной программе и readme.txt — хелп. А некоторым программам не обойтись без 26 томов печатной документации. Полноценные руководства пользователя для shareware-продуктов
— явление довольно редкое, а уж печатная документация — вещь вообще невиданная (а
если она и есть, то, как правило, продается за деньги, сравнимые со стоимостью самой
программы). И потому тем более стоит проявить во всей красе литературные таланты
и любовь к потенциальному пользователю, создавая online help. Ведь и от него зависит
рейтинг, количество звездочек и «коров», которые будет носить ваша программа на
различных shareware-серверах. Кстати, о литературных талантах: люди, профессионально
занимающиеся созданием документации к программам (technical writer) — явление на
компьютерном рынке достаточно редкое, дефицитное и потому высокооплачиваемое — так
что есть шанс, что тренировка не пройдет даром.
Как я уже сказал, хелп может иметь самый различный вид — от обыкновенного
текстового файла или стандартного долгожителя WinHelp до профессионально сверстанного
файла в формате PDF (как, например, в программе Adobe Acrobat Reader). И уж самый
последний писк моды нашего Интернет-века — это HTML Help.
Продукт под таким названием разработан компанией Microsoft, а
его аналоги-конкуренты, использующие в качестве формата представления информации
HTML, носят собственные названия: это прежде всего NetHelp от компании Netscape,
WebHelp от Oracle и, наконец, JavaHelp от Sun (к сожалению, война браузеров не прошла
мимо форматов справочной системы).
Осмелюсь дать совет: если вы сегодня собираетесь создавать хелп
к своей программе, выбирайте HTML Help от Microsoft. Тому есть множество причин:
по сравнению с традиционными форматами справки, новый HTML Help предоставляет автору
гораздо больше средств для достижения целей, ранее труднодостижимых, и при этом
почти не требует дополнительных знаний. HTML Help на сегодняшний день — это наиболее
завершенное решение изо всех существующих HTML-хелпов, и он уже поставляется в составе
Windows 98 и Windows 2000. Немаловажно для shareware и то, что HTML Help от Microsoft
(при правильном его использовании) производит неизгладимое впечатление на обозревателей
различных shareware-серверов — для примера скажу, что review моей программы на сервере
ZDNet состояло из десяти строчек, три из которых являлись комплиментами и восхищенными
словами в адрес HTML Help (и еще три были посвящены поруганию многочисленных грамматических
и орфографических ошибок в английском языке, на котором этот самый хелп был написан).
За работу!
В случае текстового файла или справки в формате WinHelp понадобится
всего лишь Microsoft Word (кстати, лучше Word 95, потому что для использования в
этих целях Word 97 вам понадобится скачать с сервера Microsoft дополнительную программку
rtffix) и компилятор Help Workshop. Если захотите воспользоваться специализированными
средствами для создания WinHelp’ов — к вашим услугам огромнейший арсенал программ.
Одной из лучших программ для создания «традиционных» справочных систем является
shareware-программа российской фирмы
Anet Software. AnetHelpTool
позволяет редактировать файлы справки в двух режимах — Runtime и Design. В первом
режиме можно просматривать документ практически в том же виде, как он будет выглядеть
в WinHelp после компиляции, а во втором — редактировать текст и графику. Интерфейс
у этой программы довольно удобный, что позволяет сделать все легко и быстро. К сожалению,
насколько мне известно, пока существует версия AnetHelpTool только для Windows 3.x.
Создание справочной системы в формате hlp — не совсем тривиальная
задача, поэтому если вы все-таки прислушаетесь к моему совету и решите делать хелп
в формате HTML, тем самым здорово облегчите себе жизнь. Для этого необходима какая-нибудь
программка для редактирования HTML (Notepad, Microsoft FrontPage, Homesite, etc.)
и компилятор HTML Help (например бесплатный

HTML Help Workshop от Microsoft).
Разумеется, авторы специализированных программ для создания хелпов
и в этом случае о вас не забыли: большинство популярных пакетов уже выпущено в версиях
для HTML (например, продукты компании
ForeFront и
Blue Sky).
Особенно хочется отметить ForeHelp от ForeFront. Эта программа
позволяет не задумываться о том, в каком формате вы хотите создать свою справочную
систему… до самого этапа компиляции. То есть вы можете написать текст и лишь после
этого выбрать вид, в котором он предстанет перед пользователем (поддерживаются форматы
WinHelp 3.1, WInHelp 95, HTML/Microsoft, HTML/Netscape, стандартный HTML 3.2 и даже
просто создание печатной документации). Кроме того, из всех подобных программ именно
эта мне понравилась гораздо больше остальных. Богатейший набор функций и при этом
абсолютная легкость доступа ко всем параметрам будущей справочной системы объединены
в настолько хорошо продуманном интерфейсе, что складывается ощущение роста функциональности
программы по мере роста ваших потребностей. Дополнительно: макроредактор, редактор
ключевых слов и «связанных» тем (related topics), topic gallery и удобная работа
с изображениями — одним словом, рекомендую!
Для полного набора, пожалуй, понадобится еще и «What’s This?
Help Composer» от уже упомянутой компании Blue Sky Software. Эта программа делает
легкой и простой нудную задачу создания контекстной справки. Если у вас есть готовый
exe-файл, ActiveX-элемент или проект на Visual Basic, то с помощью этой программы
вы сможете автоматически создать ко всем диалогам шаблон контекстной справки. Не
надо больше придумывать разные ID_, долго и пытливо просматривать все диалоги и
делать прочие совсем не интересные вещи. Все сделано так просто и изящно, что после
мытарств с «ручным» выполнением той же самой работы хочется заплакать от удовольствия!
Пять звездочек ZDNet Software Library, видимо, просто так не дают…
Что писать?
Не забывайте, что хелп пишется для пользователей, и пишите его
языком этих самых пользователей. Хелп — это не техническое описание программы: в
большинстве случаев пользователя мало волнует, что «данный элемент является контролом
типа CEdit, и потому ему присущи все ограничения данного типа контрольных элементов»
(реальный пример из одной программы, не имеющей никакого отношения к программированию).
Кроме того, неплохо помнить, что в справку обычно заглядывают не от хорошей жизни,
а когда понадобится найти ответ на какой-то конкретный вопрос.
Прежде всего вам нужно определить структуру будущей справочной
системы. Для любой shareware-программы жизненно необходимы разделы типа «How to
order», «Description» или «Introduction», «Our site», «Technical support». Весьма
разумно выделить эти четыре раздела в отдельную секцию.
Вообще, для текста и содержания справочных систем характерны
два подхода: либо вы рассказываете для чего что-то предназначено, либо о том, как
что-то сделать (wanting to know vs. wanting to do). Оба этих подхода имеют право
на жизнь, и какой из них выбрать — решать вам. Решать, естественно, не от фонаря,
а исходя из тех вопросов, которые задают пользователи на стадии, когда хелпа еще
нет (а обычно, пока программа существует в виде первых бета-версий, его и не бывает).
В конце концов, грамотно написанный хелп избавит вас от кучи дополнительных вопросов
тех же самых пользователей.
Одной из самых широко распространенных ошибок при создании справочной
системы является злоупотребление длинными и подробнейшими объяснениями, превращающими
хелп в некое подобие научного трактата. Оставьте подробные объяснение для печатной
документации (которой, скорее всего, у вас не будет), а в хелпе быстро и точно помогите
пользователю найти ответ на волнующий его вопрос.
Надо сказать, что справочная система — это не только некий абстрактный
файл справки, но еще и контекстная система помощи. Обычно пользователи довольно
неохотно берутся запускать первый пункт из меню Help (потому что в этом случае им
придется искать и разбираться в справке), но вполне готовы нажать F1 на каком-то
пункте меню или воспользоваться вопросиком «What’s This?» в диалогах — так что именно
разработке системы контекстной помощи следует уделить наибольшее внимание. А это,
вообще говоря, не совсем тривиальная задача, над которой придется подумать не меньше,
чем над проектированием любой другой части интерфейса программы.
Наконец, нельзя не затронуть такую весьма болезненную для большинства
отечественных шареварщиков тему, как перевод системы помощи на английский язык.
Разумеется, лучше, если ваш английский будет понятен людям, на нем разговаривающим.
Найти знакомого, который за некоторую сумму (а то и бесплатно) переведет ваш хелп
на некий «промежуточный» вариант английского языка, нетрудно, но мой вам совет:
не пожалейте бесплатной регистрации, найдите англичанина или американца, который
доведет качество перевода до хорошего уровня. И уж ни в коем случае не представляйте
свое творение на суд обозревателей
ZDNet, пока не будете уверены
в отсутствии грамматических и стилистических ошибок. По собственному опыту знаю
— плохой английский язык перевесит для ZDNet все достоинства вашей программы. Им
будет совершенно не важно, что вы из России, когда они напишут о вашей программе
что-то типа: «There is an attractive HTML style hyperlinked help document, but the
spelling and grammar errors detract from its usefulness».
Самая ненужная часть вашей программы
Так случилось, что с момента написания первых строк этой статьи
до ее завершения прошло довольно много времени. За это время мой приятель, о котором
я упомянул вначале, успел написать хелп к своей программе и вчера приходил ко мне
показывать свой шедевр во второй раз. Как изменились акценты за прошедшее время!
Теперь он уже всячески просил меня нажимать во всех диалогах на значок контекстной
справки и просматривать ее чуть ли не ко всем элементам программы! Самое печальное,
что, поработав с его программой почти целый день, я пришел к выводу, что без справки
ее использовать просто невозможно… И это подтолкнуло меня к совершенно неожиданному
заключению.
Есть две вещи, которые, безусловно, необходимы любой профессиональной
программе. Во-первых, такая справочная система, которая позволяет легко и быстро
разобраться во всех возможностях вашей программы. И во-вторых, такой интерфейс,
который позволит пользователю никогда не задумываться о том, есть ли у вашей программы
хелп.
Успехов!

помощь, помощник, подсказка, подмога, помогать, способствовать

существительное ↓

глагол ↓

Словосочетания

there’s no help for it — тут ничего не поделаешь  
to call for help — взывать о помощи  
to deny smb. help / to deny help to smb. — отказывать кому-л. в помощи  
to be generous in giving help — быть всегда готовым помочь  
help yourself — угощайтесь  
big / great help — огромная помощь  
domestic / home help — помощь по дому  
to give / offer / provide help — помогать  
to call for / seek help — искать, просить помощи  
the hired help — наёмные работники  

Примеры с переводом

Фразовые глаголы

help along — способствовать, помогать продвигаться, развиваться, оказывать содействие
help down — помочь сойти
help forward — помогать продвигаться, развиваться, способствовать, содействовать
help in — помочь войти
help off — помочь снять, помочь отделаться от
help on — помогать, продвигать
help out — выручить, помочь выйти, выводить из затруднения, помочь в затруднении, класть
help over — выручить, помочь в затруднении
help up — помочь встать, помочь подняться

Возможные однокоренные слова

helper  — помощник, подручный, подсобный рабочий, вспомогательный паровоз
helpful  — полезный
helping  — помощь, порция, помогающий
helpless  — беспомощный, беззащитный, неумелый

Формы слова

verb
I/you/we/they: help
he/she/it: helps
ing ф. (present participle): helping
2-я ф. (past tense): helped
3-я ф. (past participle): helped

Всем нам хотя бы раз в жизни приходилось просить о помощи. Помощь – это то, в чём рано или поздно нуждается каждый, поэтому и выражения с этим словом в любом языке весьма многочисленны. Английский язык – не исключение, и кроме всем известного help и сan I help you? существует множество выражений, связанных с этим словом. Что ж, давайте посмотрим, как можно употреблять это слово, и научимся говорить о помощи по-английски.

Использование глагола help

Начнём с грамматики. Вопреки распространённому убеждению, которому нас часто учат в школе, слово help можно употреблять как с частичкой to, так и без неё:

He helped me to wrap the present for her birthday. – Он помог упаковать подарок на ее день рождения.

The secretary helped him fill out the application form. – Секретарь помогла ему заполнить регистрационную форму.

Глагол help чаще всего употребляется по отношению к людям. Это вполне естественно – всё-таки чаще всего помощь рассматривается как акт доброй воли со стороны других людей.

He devoted his life and time to helping the sick people around the world. – Он посвятил свою жизнь помощи больным по всему миру.

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

Good sleep might help your headache. – Хороший сон может помочь тебе избавиться от головной боли.

Crying won’t help. – Слезами горю не поможешь.

Синонимы к глаголу help

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

He assisted the professor with organization of the conference. – Он помогал (ассистировал) профессору в организации конференции.

Если кто-то содействует чему-то, то в английском за это действие отвечает глагол to abet. Глагол to aid означает предоставлять что-то полезное, чтобы помочь. На ресурсе dailywritingtips.com вы найдете не меньше 85 возможных синонимов и фраз, которые обозначают какой-то вид помощи. Многие ли из них вам известны?

В разговорной речи часто используется выражение to help out (or to lend/give a hand). Оно ближе по значению к русскому варианту «выручать», но хотя и обычное «помочь» тоже часто подходит в качестве перевода.

Could you help me out and give a call to Jane? Мy battery is dead. – Не мог бы ты меня выручить и позвонить Джейн? У меня села батарея.

Occasionally I help out / give a hand at the grandpa’s home. – Время от времени я помогаю дедушке по дому.

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

• To help smb into/out of/across – помочь кому-то сесть в… / выйти из… / перейти через…
• To help smb on/off with smth – помочь кому-то надеть/снять верхнюю одежду.
• To help yourself to smth – угощаться чем-то.
• To give smb a helping hand – помогать кому-то / протянуть руку помощи.

I don’t need your help to get into the taxi. – Мне не нужна твоя помощь, чтобы сесть в такси.

Would you mind if I helped you with the coat? – Вы не возражаете, если я Вам помогу с пальто?

Can I help you to some wine? – Могу ли я угостить Вас вином?

Please, help yourself to more cake. – Пожалуйста, берите ещё тортик.

My sister is an angel. She has been giving me a helping hand with children since my second child was born. – Моя сестра – ангел. Она помогает мне с детьми с того момента, как родился мой второй ребенок.

Другие значения глагола help

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

His appearance was so funny! I couldn’t help laughing. – Его внешность была такой смешной! Я просто не смогла сдержать смех.

I can’t help thinking that I have made a terrible mistake. – Я не могу перестать думать, что совершил ужасную ошибку.

Из данных примеров мы видим, что выражение can’t/couldn’t help doing smth употребляется в тех случаях, когда действие как бы неподвластно человеку, он хочет чего-то не делать, но не может.

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

I can’t help but eat after 6 p.m. – Я не могу удержаться от того, чтобы не есть после 6 вечера.

Her mother couldn’t help but notice a big bruise under her eye. – Её мама не могла не заметить большой синяк у неё под глазом.

I can’t but mention this wonderful example of self-denial. – Не могу не упомянуть этот чудесный пример самоотречения.

Конструкция can’t/couldn’t help but do smth, как мы видим, зачастую подразумевает непроизвольное действие, что-то, чего мы не можем не делать – то есть действие настолько органичное, что человек даже не пытается его сдержать.

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

I can’t help it if he fails the exam. – Если он провалит экзамен – я здесь ни при чём.

She always gets nervous when she speaks in public, she can’t help it. – Она всегда нервничает, когда говорит перед аудиторией, она просто ничего не может с этим поделать.

They couldn’t help the accident. – Они не могли предотвратить аварию.

Cписок выражений, которые помогут нам «снять с себя ответственность»

А ещё слово help образует ряд производных, весьма полезных в повседневной речи. Вот несколько из них:

Ну что ж, в конце остаётся лишь пожелать, чтобы у нас в жизни всегда были рядом верные и надёжные помощники, и чтобы просить о помощи приходилось как можно реже!

Если вы нашли ошибку, пожалуйста, выделите фрагмент текста и нажмите Ctrl+Enter.

help — перевод на русский

/hɛlp/

Показать ещё примеры для «помочь»…

Показать ещё примеры для «помощь»…

Показать ещё примеры для «помогать»…

Показать ещё примеры для «поделать»…

Показать ещё примеры для «могу»…

Показать ещё примеры для «спасите»…

Показать ещё примеры для «подмога»…

Показать ещё примеры для «угощайтесь»…

Показать ещё примеры для «выручили»…

Показать ещё примеры для «помощник»…

Время на прочтение
5 мин

Количество просмотров 21K

Роли

Для начала давайте определимся с типовыми ролями в проекте. Обычно к созданию справки причастны:

• Разработчик (программист или продакт менеджер);
• Технический писатель;
• Менеджер проекта.

Сюда можно добавить еще редактора, переводчиков и дизайнера.

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

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

Сами vs. аутсорс

Если у вас большая компания, много продуктов и есть чем загрузить технического писателя на 100%, оптимально будет найти или вырастить технического писателя. Следует учесть, что технический писатель — это достаточно редкая профессия; эти люди всегда имеют много хорошей работы и редко ее ищут, т.е. отделу кадров придется поднапрячься.

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

Отдельно стоит упомянуть и инструменты создания справки. Не всегда для разработчика оправдана покупка программных систем для создания справочной документации. Если у вас небольшая утилита, и нужен лишь Getting Started, не стоит заморачиваться с покупкой дорогостоящего софта.

Отдавать разработку справки на аутсорсинг полезно еще по одной причине. Внешние технические писатели могут найти баги, посоветовать разработчику некоторые улучшения в интерфейсе или предложить собственные идеи по развитию программы. Этот пристальный (а технический писатель изучает программу глубже обычного пользователя) “взгляд со стороны” никогда не окажется лишним. Разработку справочной документации может считать дополнительной стадией QA.

Требования к результату

Итак, ближе к делу.

Не важно, своими силами или силами аутсорсера вы будете делать справку, на первом этапе вам потребуется четкое представление о том, что собственно нужно. Справка бывает разная, я писал об этом в прошлой статье Виды и форматы справок (инфографика) — выберите, что вы хотите в качестве конечного результата.

Процесс

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

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

1. Бриф

Даже если вы собираетесь писать справку самостоятельно, сперва будет неплохо ответить себе на ряд важных вопросов о продукте. А если справку вы заказываете на стороне — будет странно, если вам эти вопросы не зададут.

Этот документ (бриф) послужит своего рода ТЗ для технического писателя. В процессе заполнения вы точно определяетесь с требованиями к формату справки, примерным объёмом текста, целевой аудиторией, языками, уровнем подготовленности пользователя и т.д.

2. Содержание

Правильно составленное содержание — это половина дела. Если материал справки хорошо структурирован, ваши пользователи найдут нужную информацию за пару кликов. Не спешите сразу же писать текст, лучше детально проработайте иерархию и уровни вложенности топиков.

Для работы со структурой справки можно использовать простой spreadsheet. По ходу составления содержания вы сможете определиться с обязательными для упоминания моментами, ключевыми словами (онлайн-хелп на сайте послужит и для SEO), количеством и содержанием скриншотов, приблизительным объёмом текста. На этом этапе можно оценить сроки и бюджет проекта.

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

3. Оформление хелпа

Общее оформление справки может как отпугнуть пользователя, так и наоборот, показать, что для разработчика важна каждая мелочь. Если бюджет позволяет, а душа требует прекрасного, то наймите для этой задачи дизайнера. Вы должны определиться с шаблонами и стилями страниц для всех форматов справки, выбрать разрешение и тему скриншотов. Небольшой хинт: чёрный текст (а для любителей яблок — серенький и синенький ) на белом фоне всегда смотрится аккуратно и профессионально, поэтому не спешите напихать в оформление кучу цветов, стилей и прочих украшений.

Все работы по оформлению ведите параллельно и независимо от написания текста. Так вы сэкономите время и быстрее получите пилотный вариант справки.

4. Контроль промежуточных версий

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

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

5. Финальная версия

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

Прочтите получившийся хелп целиком и внесите последние правки.

6. Вычитка (пруфридинг)

Я рекомендую отдавать текст справки на вычитку профессиональному редактору. Грамотный текст и отсутствие опечаток и ошибок повышают доверие пользователей к компании и авторитет разработчика.

7. Экспорт документации

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

Инфраструктура

Для хранения проектов справки, иллюстраций и исходных данных я рекомендую использовать облачные хранилища данных с возможностью многопользовательской работы и контролем версий (dropbox, box.com), а так же онлайн-документы (googe docs, office360).

В качестве хранилища данных подойдёт Box.com. Плюсы:

• синхронизация с локальными файлами
• система уведомлений
• комментарии к файлам
• история версий
• права доступа

Для брифов, таблиц со структурой хелпа удобно использовать Google Docs. Плюсы:

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

Финал

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

А пока жду от вас комментариев, предложений и вопросов. Как справочную документацию пишете вы?

Об авторе

Alconost занимается локализацией приложений, игр и сайтов на 60 языков. Переводчики-носители языка, лингвистическое тестирование, облачная платформа с API, непрерывная локализация, менеджеры проектов 24/7, любые форматы строковых ресурсов.

Мы также делаем рекламные и обучающие видеоролики — для сайтов, продающие, имиджевые, рекламные, обучающие, тизеры, эксплейнеры, трейлеры для Google Play и App Store.

Подробнее: https://alconost.com