Требования

Жанры технических текстов:

• руководство пользователя;
• туториал;
• справка, инструкция;
• сообщение об ошибке;
• текст в интерфейсе (контролы, кнопки, подсказки);
• продуктовая подсказка;
• спецификация (внутренняя документация);
• база знаний;
• пост в блоге (поделиться интересным, новым);
• сообщение на форуме (вопрос–ответ).

Руководство пользователя:

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

Туториал:

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

Сообщение об ошибке:

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

Текст в интерфейсе:

• краткость, однозначность;
• объяснение сложного непосредственно в продукте.

Продуктовая подсказка:

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

База знаний:

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