Как написать отличное руководство пользователя практически для всего

Оглавление:

Anonim

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

Предметы, которые вам понадобятся

  • Microsoft Word или другая программа для обработки текста

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

  • Простое программное обеспечение для создания веб-страниц

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

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

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

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

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

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

подсказки

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

Предупреждение

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