Не могу сделать мануал

Скоро

Новое видео

Новое Фото

Реклама

Как написать хорошую инструкцию: 5 шагов, полезные советы, пример

Содержание статьи:

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

Инструкция — это некие указания, правила и порядок действия, для достижения какой-либо цели. Таких статей в сети Интернет тысячи и все они несут некую полезную информацию.

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

Для чего нужна любая инструкция

Ответ на этот вопрос очевиден, но поскольку мы говорим с точки зрения автора, то, для чего нужна инструкция, нам нужно разобраться чуть детальнее.

1. С точки зрения читателя — это решение его проблемы, в том или ином вопросе, в зависимости от тематики сайта, на котором она опубликована;
2. С точки зрения заказчика (владельца сайта) — привлечения целевого трафика, а как следствие потенциальных клиентов;
3. С точки зрения копирайтера — написание качественного текста, который принесет доход или упорядочит информацию в голове.

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

Какие бывают инструкции

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

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

1. Инструкция по строительству или сборке чего-либо;
2. Инструкция по применению чего-либо;
3. Медицинская инструкция;
4. Инструкция из разряда «Как сделать…»;
5. Инструкция по приготовлению пиши (рецепт);

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

Существует отдельный вид инструкций, я его называю «специфический», к нему можно отнести:

1. Пошаговую инструкцию как написать книгу;
2. Инструкцию как в домашних условиях сделать что-то для этого не предназначенное;
3. Инструкция как вести себя в той или иной ситуации.

Как написать пошаговую инструкцию (самое интересное)

По сути, эта статья — инструкция как написать инструкцию, плюс неплохо заточенные под СЕО текст с ключами. То есть, структура, выделенные ключи и заголовке в этой статье — это уже первый пример инструкции.

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

1. Найдите проблему — это очень важный этап. Кроме того, проблема, которую решит ваша инструкция должна полностью соответствовать тематике вашего сайта или сайта заказчика;
2. Разобраться в вопросе — полностью, досконально и глубоко разобраться в вопросе, о котором будете писать инструкцию;
3. Разбить решение проблемы на шаги — составе план, в котором первым пунктом будет наличие проблемы, а последним описание результата ее решения. Промежуточными же пунктами должны стать, последовательные, четкие, полные и грамотные шаги по достижению цели;
4. Распишите более подробно каждый шаг — даже уже написав текст в него всегда есть что добавить. Пусть последовательность решения проблему будет максимально подробной;
5. Схемы, картинки, примеры — добавьте в статью максимально доступную визуальную информацию. Ее должно быть немного, но в тоже время и не мало. Но помните, что не для всех инструкций такой ход необходим, как, скажем, в этой;
6. Полезные советы — добавите вставки в текст с полезными советами (также не для всех видов инструкций);

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

Вы пришли сюда из поиска? Это доказывает вышесказанное.

Как написать инструкцию: пример

Как я уже говорил выше, пример написания инструкции — это вся эта статья. Более того, большинство статей на этом сайте, которые начинаются со слова «Как» — являются инструкциями, в той или иной степени.

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

Источник статьи: http://yourwriter.ru/articles/general-articles/how-to-write-a-good-instruction/

Как написать руководство пользователя: подробная инструкция

Поделитесь статьей, пожалуйста:

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

Исследуйте тему

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

Чтобы инструкция получилась полезной копирайтеру нужно разбираться в отрасли на 100%, но описывать её с позиции новичка. То есть ставить себя на место читателя. Прочитайте аналогичные статьи на похожие товары. Это поможет вам лучше разобраться в структуре и стиле такого контента.

Разработайте план и напишите текст

После тщательного изучения материала можно приступать к планированию. Продумайте, с чего лучше начать и чем продолжить. На примере инструкции к пылесосу «Xiaomi mi robot vacuum cleaner» я расскажу о принципах написания такого текста.

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

Содержание руководства пользователя на примере инструкции к пылесосу

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

Описание продукта на примере инструкции к пылесосу «Xiaomi mi robot vacuum cleaner»

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

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

Добавляйте в статью скриншоты. Наглядно понять работу программы или техники намного проще.

Добавляем скриншоты для наглядности (пример)

Пишите даже те моменты, которые кажутся очевидными и понятными без описания. Они понятны вам. Но не факт что и всем остальным тоже.

Уникальное предложение — -50% на ВСЕ курсы Skillbox. Получите современную онлайн-профессию, раскройте свой потенциал.

Пишите текст короткими предложениями с глаголами повелительного наклонения: «Включите компьютер», «Нажмите на кнопку…», «Включите в розетку…».

Пример написания текса для руководства пользователя к товару

Придерживайтесь логики и будьте последовательны. Например, при описании программного обеспечения для ПК: «Включите компьютер. Вставьте диск в дисковод…». Будет нелогично писать: «Начните работу с диском, затем включите ПК». Завершайте инструкцию ответами на частые вопросы и/или описанием неисправностей и как их устранить.

Рекомендации и советы по написанию руководства пользователя к любому товару на примере

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

Источник статьи: http://checkroi.ru/blog/how-to-write-a-user-manual/

Как написать инструкцию так, чтобы тебя поняли

Есть такая поговорка: «Хочешь сделать хорошо — сделай сам».

Для себя, действительно, так будет быстрее и спокойнее. Однако любому руководителю известно, что плохой менеджер это тот, кто не умеет объяснять и делегировать полномочия. Соответственно, умение давать четкие инструкции и план действий — задача хорошего руководителя. А помогает ему в этом «юзабельность». Давайте и разберёмся с этим понятием.

Юзабилити (от англ. usability) означает удобство в использовании, эргономичность и легкость в понимании.

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

Итак, а теперь непосредственно к главному.

Выражение: «И так сойдет» — точно не для инструкций.

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

2. Не используем в инструкции много сленга. Есть шанс, что не все сотрудники его поймут.
Пример: «Уточнить у манагеров, получила ли апрув статья». С одной стороны, написано всё понятно, но для официального документа такой сленг не подходит.

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

Примеры скриншотов с вполне понятными шагами:

4. Не пропускаем шаги, которые кажутся нам слишком простыми. Пусть лучше сотрудник, читая инструкцию, сам пропустит этот степ.

5. В тексте нежелательно использовать большие предложения. Коротко: «Зайдите в меню», «Добавьте значение…», «Выберите параметр…» и т.д.

6. Для сокращения объема текста возможно применение графических элементов. Например,

Local area connection ——> properties—>TCP/IPv4—>properties.

7. Применение шрифтовых выделений допустимо. Это привлекает внимание на особо важных пунктах.

8. Не используйте в инструкции ничего из вашего личного опыта применения того или иного продукта или использования программы. Для этого существуют отдельные встречи с сотрудниками, где вы передаете им свой ценный опыт. А инструкция — это логичная структура, где описан «шаг — действие» и ничего более.

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

Эффективная юзабельная инструкция — это не простая формальность, это один из шагов к успешности и автоматизации рабочего процесса. Зеркальный юзабилити эффект заключается в том, что вещи, которые имеют отношение к собственного опыту, мы запоминаем лучше, чем те, которые не имеют к нам никакого отношения. Поэтому написание инструкций и памяток прокачивает менеджерские навыки специалистов. А это, в свою очередь, идет в «копилку скилов».

Источник статьи: http://habr.com/ru/company/icl_services/blog/421503/

Мануал что это такое, для чего нужен и как его составить (написать, сделать)

Здравствуйте, уважаемые читатели блога: My-busines.ru. Из содержания предлагаемой вашему вниманию статьи вы сможете узнать о том, что такое мануал.

Что это такое

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

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

Для чего нужен

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

Формат

Наиболее распространенными являются следующие форматы: PDF, Word, HTML. Рассмотрим каждую из этих разновидностей форматов более подробно.

PDF-формат наиболее распространен, потому как он является межплатформенным. Изначально данный формат был создан фирмой Adobe Systems с использованием специального языка PostScript. Наиболее подходящей программой для открытия данного формата является Adobe Reader.

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

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

Как составить (написать, сделать) мануал

Написание грамотного мануала включает в себя следующие этапы:

1. Указание темы. В границах и сфере темы необходимо быть предельно внимательным и точным;
2. Определение аудитории, для которой составляется (новички, профессионалы, люди со средними знаниями, будут ли изучать самостоятельно или же коллективно);
3. Выбор количества разделов;
4. Выбор названий разделов;
5. Выбор логической структуры изложения материала. Взаимосвязь разделов должна определяться исходя из последовательности действий;
6. Составление словаря терминов, если планируется использование специальных жаргонизмов. Его необходимо будет обновлять по мере написания;
7. Определение тем, которые требуют дополнительного исследования. Если вы не уделите подготовке мануала должного внимания, то от него не будет абсолютно никакой пользы. По этой причине очень важно закончить проведение различного рода дополнительных исследований до того, как вы приступите к написанию;
8. Определение структуры каждого из разделов;
9. Организация логической последовательности каждой секции и каждого раздела, постепенно сужая границы темы.

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

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

Изображения обязательно должны быть подогнаны под размеры текста.

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

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

Проверять готовый мануал лучше всего в следующей последовательности:

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

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

Источник статьи: http://my-busines.ru/useful/manual-chto-jeto-takoe-dlja-chego-nuzhen-i-kak-sostavit-napisat-sdelat-manual

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

Что нужно для создания справочного файла? Большинство используют для этого кнопку PrntScr и текстовый редактор. Но на самом деле можно отказаться и от того, и от другого. Есть программы и веб-сервисы, о существовании которых многие разработчики (и даже составители технической документации) просто не догадываются. Специализированные решения для создания мануалов, руководств пользователя и прочих подобных документов, как правило, объединяют текстовый редактор с минимальным набором функций, приложение для создания скриншотов, а также средства для экспорта в популярные форматы документов. Более того, некоторые из таких программ делают большую часть работы за пользователя, самостоятельно расставляя снимки экрана в нужной последовательности и даже добавляя описания. Разберем пять наиболее удачных — на наш взгляд.

⇡#Clarify 2.0.5 – быстрые мануалы без дополнительного софта

• Разработчик:Blue Mango Learning Systems.
• Операционная система: Windows/Mac.
• Распространение: shareware, $30.
• Русский интерфейс: нет.

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

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

Чтобы добавить скриншот в любое место документации, достаточно выделить нужный заголовок и нажать на кнопку захвата экрана. Если скриншоты были созданы ранее, можно добавить их в документ, указав путь к ним на диске. Снимок экрана можно сделать как моментально, так и с небольшой задержкой (до пяти секунд), что может быть удобно, если нужно сделать скриншот выпадающего меню или другого элемента интерфейса, который постоянно не отображается на экране. Нажимая клавишу «Пробел», можно переключаться между захватом всего экрана или же текущего окна. Кроме этого, предусмотрены горячие клавиши для включения/выключения отображения курсора и для захвата области того же размера, что и предыдущий скриншот. Последняя функция очень удобна, если нужно делать десятки однотипных снимков экрана, так как при этом экономится время на выделение требуемой области.

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

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

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

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

Над проектами Clarify можно работать совместно с другими пользователями. Для этого нужно создать учетную запись на сайте Clarify-it.com. Кроме этого, программа поддерживает сервисы Dropbox и Evernote, дает возможность экспортировать проекты в PDF, Word, HTML и на сайты WordPress. При желании можно также просто скопировать весь текст документа (или же текст с картинками) в буфер обмена.

При экспорте можно выбирать тему оформления, добавлять колонтитулы, управлять разными параметрами отображения (в зависимости от формата). Например, для экспорта в Word доступны три темы оформления, а готовый документ представлен в виде идеально отформатированного файла, со стилями, заголовками, списками, гиперссылками. Работать с таким одно удовольствие, особенно если помнить о том, сколько времени нужно потратить на подобное форматирование в Word вручную.

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

⇡#Dr.Explain 5.3 – полуавтоматические руководства с готовыми аннотациями

• Разработчик: Indigo Byte Systems.
• Операционная система: Windows.
• Распространение: shareware, от 7 500 рублей.
• Русский интерфейс: есть.

Dr.Explain не может похвастаться таким современным интерфейсом, как Clarify, однако у этой программы есть свои уникальные особенности. Пожалуй, самое главное – это автоматизация процесса создания технической документации. Просто укажите окно приложения или же веб-страницу сервиса, которые нужно описать, и Dr.Explain самостоятельно создаст скриншот, проанализирует все элементы интерфейса, добавит выноски и даже подпишет их там, где это возможно.

Если в интерфейсе захватываемого приложения встретится меню, Dr.Explain обязательно раскроет его, сделает снимок всех уровней подменю и добавит выноски для каждого элемента. Более того, все скриншоты будут помещены в проект Dr.Explain с сохранением структуры документа (то есть, скажем, основное окно будет в разделе 1, раскрытое меню – 1.1, а пункты подменю – 1.1.1, 1.1.2 и так далее). Таким образом, вся скучная и монотонная работа выполняется в автоматическом режиме, и пользователю остается только добавить описание всех элементов интерфейса. Понятное дело, что структуру документа можно изменять, перемещая пункты, добавляя новые и удаляя ненужные.

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

Если ранее работа над документацией велась в другом приложении, можно легко импортировать проект и программу. Dr.Explain поддерживает импорт документов CHM, Word, HTML, HLP, RTF, TXT, XML.

Совместная работа над документацией организована через сервис Tiwri.com, созданный специально для обмена данными между пользователями Dr.Explain. Из окна программы можно загружать текущий проект на сервер, отсылать изменения, сбрасывать правки, отслеживать историю.

Для экспорта готовой документации предлагаются форматы CHM, Word, HTML и PDF. При этом еще до выполнения экспорта можно увидеть, как мануал будет выглядеть в одном из этих форматов. Перед экспортом нужно не забыть перейти в настройки проекта и задать дополнительные параметры. Например, при сохранении документа в PDF можно указать ключевые слова, автора, заголовок, тему и формат, настроить колонтитулы и нумерацию страниц, а также создание закладок для разделов. При экспорте в HTML есть возможность настроить карту сайта, добавить комментирование для пользователей Facebook* и Disqus, включить показ панели с кнопками социальных сетей, указать данные FTP-сервера, на который будет загружен проект.

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

⇡#Manula – перенос мануалов в онлайн

• Разработчик: Bitz & Pixelz.
• Операционная система: любая.
• Распространение: по подписке (от $10 в месяц).
• Русский интерфейс: нет.

В начале 2009 года Альвин Хогердайк (Alwin Hoogerdijk), создатель семейства приложений для учета коллекций Collectorz.com, решил создать для своих программ онлайновую справку. Ему надоело, что часто приходится откладывать выпуск новых версий программ из-за того, что еще не готовы изменения в пользовательской документации, или же, наоборот, делать новые релизы доступными для скачивания с устаревшими справочными файлами, а затем выпускать новые билды, в которых обновлены только мануалы.

Для того чтобы сделать процесс дополнения документации более удобным для разработчиков, а доступ к ней – более быстрым для пользователей, Альвин хотел перенести все в онлайн. Он начал поиск специализированной системы управления контентом, предназначенной для создания технической документации. И когда оказалось, что ничего подобного не существует, разработчик создал собственную систему для своего семейства приложений. Позже она была превращена в более универсальный коммерческий продукт Manula.com.

Manula.com дает возможность создавать и обновлять мануалы в браузере, без необходимости использования настольных приложений. Главное преимущество онлайнового мануала – мгновенное обновление. Как только разработчики внесли в него изменения, обновленные справочные файлы уже становятся доступны пользователям — не надо ничего никуда экспортировать, загружать на сервер HTML-файлы и так далее. При этом мануалы смотрятся одинаково хорошо на любых устройствах – на больших мониторах, планшетах или смартфонах. Сервис автоматически выполняет адаптацию под размер экрана.

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

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

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

Одна из интересных особенностей Manula – функция Topic Sharing. Если у компании есть несколько однотипных продуктов, то отдельные фрагменты справки можно сделать для нихобщими. Главное отличие от простого копирования готовых фрагментов документации в том, что при использовании функции Topic Sharing вносить изменения нужно лишь в одном месте. При этом во всех приложениях документация будет обновляться автоматически. Еще больше автоматизировать процесс помогают переменные (например, {APPNAME}), которые настраиваются отдельно для каждого руководства пользователя.

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

Встроенного инструмента для создания снимков экрана в Manula нет – придется загружать готовые картинки в библиотеку изображений (она общая для всех проектов) и затем вставлять в нужные места документации. Добавление текста тоже выполняется в онлайновом редакторе, и тут разработчики сервиса смогли придумать кое-что интересное. Наряду с использованием визуального редактора предлагается работать с кодами Textile для ускорения процесса форматирования. Эти коды дают возможность форматировать текст без необходимости обращения к кнопкам редактора. Например, если текст нужно выделить, его просто нужно заключить в две звездочки (*вот так*), а для создания заголовка первого уровня достаточно написать в начале строки h1-.

⇡#StepShot – снимет, расставит по порядку и подпишет

• Разработчик: StepShot.
• Операционная система: Windows.
• Распространение: по подписке ($29 в месяц). Есть полнофункциональная триал-версия на 14 дней, которая затем становится ограниченной.
• Русский интерфейс: нет.

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

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

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

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

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

Если инструкция объемная, имеет смысл разбить ее на разделы, добавляя разделители в нужных местах. Для каждого раздела есть возможность задать название. На основе разделов будет автоматически сгенерировано оглавление, которое расположится в начале руководства.

Обычно при создании руководств много времени тратится на то, чтобы выделить область, в которой находится курсор на скриншоте (как правило, место, куда нужно кликнуть). StepShot дает возможность автоматизировать и это рутинное действие. Элемент интерфейса, по которому выполняется щелчок мышью, может быть автоматически выделен красным прямоугольником или же желтым кругом. Кроме этого, программа может автоматически сглаживать края скриншотов.

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

Добавление описаний тоже максимально автоматизировано. Поскольку при написании технической документации чаще всего используются одни и те же словосочетания, программа снабжает скриншоты описаниями вроде «Click on «Skype» button». Для этого она захватывает названия элементов интерфейса, распознает их и затем добавляет в подпись под картинкой. Работает это, правда, только для английского и парочки других европейских языков, а составителям русскоязычной документации придется добавлять все описания вручную.

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

После того как работа над созданием руководства завершена, можно экспортировать его в один из нескольких поддерживаемых форматов: документ Word, PDF, HTML, DITA или XML. При этом для Word доступно несколько разных шаблонов.

Также есть прямая публикация на WordPress и в Confluence, а все изображения, использованные в проекте, предлагается сохранить в одной папке. К сожалению, при этом можно управлять только качеством картинок, а вот менять названия нельзя. Скриншоты сохраняются с названиями типа image0001.jpg, image0002.jpg, что не всегда удобно (было бы неплохо, если бы была возможность именования изображений на основе заголовков в проекте).

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

⇡#iorad – аналог StepShot, но в браузере

• Разработчик: iorad inc.
• Операционная система: любая.
• Распространение: по подписке ($90 в месяц). Есть ограниченная бесплатная версия.
• Русский интерфейс: нет.

Для начала работы с iorad нужно установить расширение для Google Chrome и открыть веб-страницу, действия на которой должны быть задокументированы. После этого автору нужно нажать на кнопку расширения. В веб-сервисе iorad применён тот же подход, что и в StepShot (автор инструкции выполняет все действия, сервис их сохраняет, разбивает на шаги, которые затем можно отредактировать и опубликовать в виде урока). Однако iorad работает как расширение к браузеру, и все действия по обработке, редактированию и публикации пошаговых инструкций выполняются на сервере. С одной стороны, это удобно, так как сервис доступен на любой платформе, однако есть досадное ограничение – с помощью iorad можно записать только действия, выполняемые в браузере. То есть сервис подходит только для создания мануалов веб-приложений, а для настольных программ не годится.

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

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

Каждый урок начинается предложением «The first step is to open [название вебс-страницы]», а заканчивается фразой «That’s it. You’re done.» Несмотря на то, что описания автоматически составляются только на английском, в готовой инструкции есть возможность увидеть их на других языках за счет интеграции с переводчиком Google. Если не добавлять пространных описаний, а ограничиться простыми фразами, такой перевод работает сносно.

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

Что касается инструментов для редактирования снимков экрана, то тут создателям iorad еще есть над чем работать. Все, что может делать пользователь, это смазывать часть изображения, а также изменять размер и местоположение рамки для выделения.

Готовые инструкции могут быть сохранены в виде файлов Word Doc, PowerPoint и PDF, а также внедрены на сайты или просмотрены в браузере на любых платформах, как настольных, так и мобильных. Используя последние два варианта, можно оценить главное преимущество iorad – интерактивность. Инструкция, полученная с помощью сервиса, запускается в специальном плеере. Пользователь может выбрать один из вариантов работы с ней: просмотр или же самостоятельное повторение всех шагов.

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

⇡#Заключение

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

Работая над документацией, стоит всегда помнить о «принципе Златовласки»: пользователю надо давать не слишком много информации, не слишком мало, а в точности столько, сколько нужно для выполнения задач. Хорошая документация должна работать как навигатор: как только пользователь показал, в каком месте он находится (с какой проблемой столкнулся), он тут же должен при помощи файла справки отыскать правильный путь (решение проблемы). И конечно, не стоит забывать о гиперссылках, при помощи которых нужно обеспечивать свободное перемещение пользователя по мануалу. Если в его руках подробнейший PDF на 100 страниц, в котором нет никаких ссылок, качество такой документации вряд ли может оценить кто-то, кроме ее составителя.

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

* Внесена в перечень общественных объединений и религиозных организаций, в отношении которых судом принято вступившее в законную силу решение о ликвидации или запрете деятельности по основаниям, предусмотренным Федеральным законом от 25.07.2002 № 114-ФЗ «О противодействии экстремистской деятельности».

Была ли эта статья полезной?

Григорий Остер — Вредные советы для писателей мануалов

Недавно мне опять пытались продать «Тик-ток». Молодёжь заливалась песнями о том, как же прекрасна новая платформа. «Возможно» — сказал я — «И чем же она так прекрасна?»

— Ну, там можно научиться огромному количеству новых и неизвестных вещей.
— А… Правда? Ок, удиви меня.
— Вот! – наивный юнец с радостью ткнул на указатель на приборной панели своей «Хонды».
— И что же в этом такого прикольного?
— Видишь стрелку? Она показывает с какой стороны у тебя крышка бензобака, чтобы ты помнил, где останавливаться у бензоколонки.

Я тяжело вздохнул, открыл бардачок, и, к ужасу парнишки, извлёк из него потрёпанный мануал 2004 года выпуска. После 20 секунд листания оного мануала, я ткнул пальцем в ту самую иконку, которая показывает, с какой стороны у тебя бензобак.

— Ну вот, пожалуйста. Это было известно ещё до «Тик-тока», и даже до «Фэйсбука». Эх! Это было известно ещё до интернета и, возможно, до появления автоматической коробки передач. Это было известно до того, как твои родители появились на свет. Ты мануал-то читал?
— Нет.
— Оно и видно.

Признайтесь, люди не читают мануалов. Давайте посмотрим, что Вам можно посоветовать, чтобы люди от них вообще избавились.

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

Возможно это произошло потому, что с детства я помнил, как мой дед постоянно возвращал к жизни старый телевизор «Фотон». Ящику было уже более 30 лет, и ломался он с завидным постоянством. Раз в год мой дед доставал отвёртку, паяльник и кучу интересного инструмента. После этого он залезал специальным щупом в трубу, и я слышал жуткий «бах». Это он так разряжал основной конденсатор, чтобы потом не убить себя всеми этими вольтами. Но самое интересное начиналось потом. Внутри самого телевизора лежала ОНА — принципиальная схема. Я просто не мог оторвать глаз от этой восхитительной карты микромира, которая казалась мне такой загадочной и непонятной, но при этом, точно проводила моего дедушку через все закоулки электронной страны. Пару тычков щупами обычно быстро находили пробитый конденсатор или сгоревший резистор. После чего ящик возвращался к жизни и продолжал служить, давая фору марсоходу Curiosity по количеству дней, прожитых после окончания срока службы.

А возможно всё было по-другому. Когда мы учились программировать на компьютерах в универе, интернет не представлял собою бесконечную базу данных любых знаний. Самым-самым был дорогой и любимый MSDN. Библиотека всех знаний Microsoft носилась с собою на каждое занятие, и Великий Хранитель Подписки был тем самым друидом, раздающим знания всем тем, кто хотел учиться и познавать новое.

MSDN читался ради удовольствия, и для того, чтобы выпендриваться перед учителем (привет, ceba!), показывая умение пользоваться изощрёнными функциями и давая доступ ко всеми любимому «зачёту автоматом».

Позже, по долгу службы, я не раз натыкался на «островки знаний». manualslib.com всегда являлся поставщиком заветных сервисных мануалов. Тех самых, невообразимо объёмных мануалов, которые описывали все внутренности принтеров, телефонов, схем и контроллеров. Тех самых мануалов, которые позволяли добраться до последнего соленоида, в котором прогнивала резинка, из-за которой дох принтер за 2000 долларов.

Когда я вёл команду джунов, которые должны были разбираться с Docker swarm я с интересом отвечал на их вопросы путём копи-паста ссылок из документации Docker. У меня не было идеи о том, что кто-то возьмётся за Докер, без хотя бы быстрого перелистывания этой документации, как минимум для того, чтобы знать, где и что лежит.

Люди не читают мануалов. Причин тому несколько.

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

Во-вторых — панический страх мануалов. Инструкции превратились в талмуды, которые выглядят одинаково удобочитаемо до и после шифрования. Что бы ни делал пользователь, ему неинтересно/нет времени/нет желания. Мы с вами живём на другой планете. Мы привыкли к тому, что, если функция не возвращает то, что от неё требуется, то мы будем лезть в docs.[nameofthecompanygoeshere].org. После прочтения кучи текста, мы вникнем в то, что шестой параметр должен быть ненулевым и заставим-таки эту штуку работать как полагается.

Но, даже в рядах инженеров и программистов появляется всё больше и больше тех, кто предпочитает stackoverflow вдумчивому пониманию предмета.

Итак, давайте разберёмся, как же сделать так, чтобы Ваш мануал канул в Лету, и как сделать так, чтобы Вам постоянно названивали в три ночи, когда всё легло.

▍ Композиция

Если Вы уже решились
Написать талмуд великий,
Чтобы всем на предприятье
Всё подробно рассказать,

Не спешите Вы нисколько
Всё раскладывать по полкам,
Начинайте где попало.
Лишь бы было что сказать.

Вот несколько наиболее отвратительных примеров в этой категории. Калифорнийский справочник водителя. Это моя любимая книга «для поржать», если очень сильно хочется. Помимо того, что она написана вразнобой, она ещё и переведена машинным переводом. Поэтому скатиться под стол со слезами можно просто так, без особых усилий. Что же тут такого интересного?

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

С этим разрешением Вы можете в течение года делать что угодно и водить всё что подходит под вашу категорию машин, но только при наличии в машине кого угодно с правами. И вот только после этого Вы можете идти и сдавать экзамен. (Хе-хе, а потом жаловаться, что на дороге полно идиотов).

Ну так вот, эта брошюра занимает 120 маленьких страниц текста и читается за 30 минут.

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

Информация о том, как, собственно, водить машину, начинается на странице 58. В середине книги.

Или вот. Возьмите любой мануал к Вашему автомобилю. Там тоже можно повеселиться. Для начала Вам приходится читать о том, как правильно устанавливать ремни безопасности для транспортировки младенцев. Несомненно, родителям малышей эта информация очень полезна, но это не 100% всей аудитории. Что самое главное в машине? Она должна ездить. Информация о том, как сделать так, чтобы она поехала, начинается примерно после 120 страниц информации о том, как она ломается и как её не нужно обслуживать.

Другой пример такого мануала — это документация по языку Rust. Об этом я уже писал. Первая глава полностью погружает читателя во все тяжкие языка. Но понять первую главу можно только изучив четвёртую… Дилемма…

Давайте посмотрим на что-нибудь приличное. Вот, например, мануал к микс-борду фирмы Mackie.

После одной страницы инструкций о том, как не убить себя током, Вам будет предложена картинка, которая покажет, как подключить гитариста, басиста, барабанщика и солиста и начать лабать Deep Purple с размаху. На следующих страницах последовательно разбираются примеры и описание неудачных случаев (например, неправильно спаянные провода). В конце документа приводятся все технические данные и псевдодиаграммы, со всеми ТТХ инструмента, то бишь, всё особо заумное.

▍ Номенклатура

Если Вы писать решили
Мануал большой и толстый,
То не парьтесь со словами.
Называйте как попало.

Если юзеру вдруг нужно,
То ответ нароет сам.

Тут в пример можно привести один из самых страшных мануалов, которые мне довелось читать в моей жизни. NEC Univerge Phone System Programming.

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

Ну так вот. Этот перечень возможно где-то и существует в глубинах компании NEC (чтоб уже этих япошек!), но добросовестным инженерам он недоступен. Например, если Вы откроете мануал на странице 246, то Вы увидите инструкции о том, как программировать ICM Key на телефоне. У Вас не будет ни малейшего понятия, что такое ICM Key. Инструкция об этом умалчивает. Думаете всё так просто, пойди и погугли? Ха, ага! Идите, попробуйте погуглите это, так, чисто по приколу. Вы увидите, что эта аббревиатура используется только инженерами NEC и никем другим. Нагуглить это будет невозможно. Просто нет никакого варианта найти эти данные в интернете. Надо будет звонить в техподдержку для инженеров, и общаться со специалистом. Если повезёт, Вам ответят.

С подобными проблемами обычно сталкивается не Вася, который решил выучить NPM за 20 минут на ютубе или Петя, который гуглит «как решить алгоритмы на собеседовании» на stackoverflow. С такой проблемой столкнёшься ты, хабраюзер, когда пойдёшь работать в реальную контору с реальными людьми. Серьёзные enterprise системы всегда достаются Вам с пачкой слов, которые никто за пределами этой системы не использует.

Название серверов, сетей, платформ и систем, которые были Вам родными последние 5 лет, пока Вы работали в ${user.CompanyName}, приелись настолько, что Вы уже не можете поверить, что кто-то об этом не знает. Некоторые про это просто не думают. Например, слово FTP может означать не протокол передачи данных, а конкретный сервер.

ПНСВ, Desktop, Та-самая-карточка, The Server, это всё те странные обиходные слова, которые непонятны никому за пределами Вашего круга общения.

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

▍ То, о чём вы говорите

Если в новом мануале
Говорим о тахионах,
То не стоит торопиться
Тахионы показать

Юзер нынче очень круто
Может сам всё рисовать.

Меня охватывают страх и трепет, после того, как я вспоминаю об одном сервисном мануале принтера. В нём не было ни одной картинки.

• Снимите переднюю панель.
• Увидите 6 шурупов, открутите их.
• Снимите боковые панели.
• Справа Вы увидите два шурупа и три гайки.
• Поверните принтер на 90 градусов по часовой стрелке, найдите шуруп под пружиной номер 85, и открутите его. Это отпустит систему держателя номер 10, которая удерживает барабан…

Ну и так далее. 

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

▍Самая главная идея вашего мануала

 Тут вредного совета не будет.  Тут сразу можно перейти к самой главной идее. Как надо писать инструкцию?

Для начала, ответьте себе на вопрос — для чего существует Ваш продукт/изделие/система? Какова её цель? Самая основная цель.

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

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

Машина позволяет быстро перемещаться по дорогам.

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

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

Самое главное — это передать идею того, что на самом деле будет происходить на следующих 100 страницах.

После этого, всё, о чём Вы говорите, можно основывать на этой мысли.

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

Внимание! Вождение автомобиля связано с риском, и неправильное использование может привести к летальным последствиям. Обязательно ознакомьтесь с данными о безопасном вождении.

Правильный уход за автомобилем гарантирует его работоспособность… И т.д.

Это то, что приятно читать, и что самое главное, это то, что можно читать.

Почему мы начинаем статьи на Хабре с хорошо продуманной КДПВ и отличного введения, а наши мануалы выглядят как ужас, летящий на крыльях ночи?

▍Зачем вам всё это?

Если вам охота очень
В воскресенье спозаранку
Получить звонок от босса
На мобильный телефон,

И, забив на выходные,
Бодро броситься в контору,
Гордо взяв клавиатуру
Побежать всё поднимать,

Не пишите мануалов.
Много помощи не будет.
Лучше Вы на всё забейте.
Всё само собой пройдёт.

Хорошо написанный мануал — это то самое чудо, которое сохраняет Вам нервы и время.

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

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

Если Вы принадлежите к последним, то подумайте вот о чём. Написанные Вами слова — это Ваш аватар. Это Ваш виртуальный помощник, который заменяет Вас перед толпой, пытающейся достать Вас вопросами.

Не парьтесь по поводу того, что у Вас нет стиля, и Вы не умеете писать. Если у Вас есть система для ввода текста в компьютер, то у Вас есть всё, что Вам нужно.

Садитесь и пишите. После этого, прочитайте то, что Вы написали и пишите ещё. Дайте это почитать несведущему человеку, посмотрите, сможет ли он понять, что Вы написали.

Главная цель мануала — сделать так, чтобы кто-то другой мог выполнить определённые действия.

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

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

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

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

Короче, если Вас запарили постоянными вопросами, и Вы чувствуете себя задёрганным, то возможно пора уже сесть и написать этот мануал. 

hanselman.com — вот один из примеров. Каждый раз, когда к Скотту приходят и задают глупые вопросы, он пишет статью в свой блог. В итоге у Вас есть блог, и повторяться не приходится. 

Пишите. Это замечательное умение. Как раз потренируетесь.