Як написати велике керівництво користувача для практично всього

Зміст:

Anonim

Давно, тверді посібники користувача супроводжували нові продукти всіх видів, надаючи широкі інструкції про те, як дізнатися всі функції і максимізувати ваше використання. Сьогодні, однак, посібники користувача, що постачаються на заводі, є набагато більш побіжними і часто на декількох мовах, що ускладнює криву навчання. Щоб мати гідний посібник користувача - це дорогоцінний товар, і якщо ви знаєте, як його писати, це великий талант. Це просто питання освоєння кількох ключових принципів.

Елементи, які вам знадобляться

  • Microsoft Word або інша програма для обробки текстів

  • Колекція картинок або цифрових фотографій

  • Просте створення веб-сторінки програмного забезпечення

Визначте формат, будь то друковані документи, веб-сторінки, електронні листи або деякі комбінації. Як тільки ви пишете в одному форматі, легко перенести його в інший. Деяким людям зручніше читати друкований документ, який вони можуть утримувати, та видаляти. Інші можуть віддати перевагу URL або посилання на документ на вашому веб-сайті.

Будьте організованими, чіткими та лаконічними. Передбачити і пояснити не тільки те, що користувачі будуть робити, але й що не робити. Ви повинні написати з очей до обох.

Почніть з самого початку, розгортаючи тільки необхідну інформацію в логічній формі. Пишіть активним голосом, не пасивно. Тримайте свою копію худу, усуваючи сторонні слова. Тримайте його простим і методичним.

Розбийте текст з фотографіями, ілюстраціями або діаграмами якомога більше. Змусити читачів пробиратися через нескінченний текст з жахливими абзацами - це вірний спосіб втратити їх. Довгі, складні абзаци та сторінки добре підходять для технічних посібників, але не підходять для простих посібників користувача. Тримайте його коротким і солодким.

Попереджайте читача, що не слід робити з різними інтервалами. Це допомагає мінімізувати розчарування при вивченні нового продукту або програми.

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

Поради

  • Пишіть дуже просто. Не припускайте жодного рівня знань. Те, що здається вам легким і обізнаним, може бути не таким для ваших читачів. Використовуйте високоякісну графіку, кліп-арт та фотографії, щоб покращити зовнішній вигляд документа та покращити читабельність. Зберігайте абзаци та описи короткими.

Увага

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