Галина!

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

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

Чтобы оплатить покупку...

Если хотите вернуть деньги на другую карту...

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

Рекомендую почитать ещё советы об инструкциях:

P. S. Это был воскресный совет о хорошем тексте. Присылайте вопросы

Текст, редактура и информационный стиль
Отправить
Поделиться
Запинить

Комментарии

«меня настораживает, что вы хотите писать инструкцию для программы»

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

13 ноя 2019

Рекомендуем другие советы