Каким бы гениальным ни был изобретатель, программист или рационализатор, порой его творениями просто невозможно пользоваться по назначению. Виной тому – неверно составленная инструкция по эксплуатации или ее полное отсутствие. Но даже гениальные изобретатели иногда пишут такие инструкции, что кроме узких специалистов никто эти бумаги прочесть не может. Так как же правильно составить такой необходимый документ?
Статьи по теме:
- Как написать руководство пользователя
- Как написать инструкцию
- Как описать программу
Вам понадобится
- — стопроцентное знание устройства или программного продукта, для которого пишется руководство;
- — познания в области языкознания;
- — навыки писательского мастерства.
Инструкция
Руководство пользователя или, другими словами, руководство по эксплуатации – документ, призванный предоставить помощь в использовании некоторой системы ее пользователям. Для составления руководства пользователя вам необходимо знать описываемую систему на все сто процентов, однако смотреть на нее глазами ничего не смыслящего школьника.
Как писать инструкции для людей? Работа персонала по инструкциям
Предположим, руководство пользователя пишется для некой программной утилиты, аналогов которой еще не было. Представьте, что вы столкнулись с этой программой впервые. С чего нужно начинать? Что необходимо знать в первую очередь? Систематизируйте эти знания, разбив их на категории важности.
Если создаваемое вами руководство предназначено для использования в крупной компании, то стоит обратить внимание на принятые там корпоративные стандарты. К примеру, во многих российских компаниях руководство пользователей не принимаются без иллюстративного сопровождения, проще говоря, картинок, поясняющих написанное. В руководстве пользователя помимо содержания должны быть и другие обязательные части:- Аннотация, то есть пояснение общих задач руководства и описываемого продукта;- введение, в котором рассказывается о связанных с руководством пользователя документах и методах использования руководства;- разделы, поясняющие об использовании продукта на разных стадиях его использования, например, первые шаги, ремонт или профилактика;- раздел часто задаваемых вопросов и ответов на них;- глоссарий или предметный указатель.
Обычно созданием руководства пользователя занимается технический писатель – человек, имеющий все не обходимые познания как в языке, так и в описываемом продукте. Занимаясь деятельностью технического писателя без соответствующей подготовки, нужно помнить о нескольких правилах. Во-первых, нельзя злоупотреблять специальными терминами, не понятными для рядового пользователя.
Во-вторых, каждый используемый термин должен быть подробно расписан и объяснен. В-третьих, писать нужно максимально понятно и лаконично. Наконец, технический писатель должен уметь смотреть на собственный текст глазами рядового пользователя, чтобы видеть недостатки собственного текста.
Всё, что нужно знать о должностных инструкциях за 6 минут
Готовый текст руководства пользователя неплохо испытать в деле, предложив его человеку, не имевшему делу с описываемым продуктом. Совместными усилиями можно ликвидировать все недочеты и подводные камни документа.
Обратите внимание
Многие виды руководств пользователя регламентированы государственными стандартами. Так, например, ГОСТ 19.101-77 описывает виды программ и программных документов, ГОСТ 19.105-78 – общие требования к программным документам, а ГОСТ 19.505-79 – требования к содержанию и оформлению руководства оператора ЭВМ.
- Руководство для разработчиков технической документации к программному обеспечению
Совет полезен?
Статьи по теме:
- Как написать должностную инструкцию
- Как написать интерпретатор
- Как перевести инструкцию
Добавить комментарий к статье
Похожие советы
- Как составляется должностная инструкция для инженера
- Что такое должностная инструкция и порядок ее оформления
- Как написать памятку
- Как настроить интернет на телефоне в сети Tele2
- Как написать спецификацию
- Как составить производственную инструкцию
- Как оформить методические рекомендации
- Как составить документ
- Как написать должностные обязанности
- Как написать должностные инструкции сотрудникам отдела
- Как составить методический план
- Как подключить к интернету беспроводной модем
- Как делать спецификацию
- Как запрограммировать быстрый набор
- Как найти напряжение, зная мощность
- Как обнулить компьютер на BMW
- Как подключить руль Defender к компьютеру
- Как настроить универсальный пульт Vivanco
- Как в фотошопе повернуть картинку
- Как отключить вспышку на фотоаппарате
- Как настроить клавиатуру Defender
- Как составить должностную инструкцию для инженера
Источник: www.kakprosto.ru
Как писать инструкцию
Инструкция представляет собой справочную документацию, в которой указаны особенности и правила эксплуатации того или иного товара. При этом она может быть реализована в различных вариантах оформления. Инструкцией по факту есть не только руководство пользователя, которое прилагается к условной бытовой технике, но и раздел ответов на самые частые вопросы на сайте или даже текст, размещенный на пакете молока.
Предоставление покупателю соответствующей информации регламентируется законодательством – она должна присутствовать в обязательном порядке. Поэтому всерьез задуматься о том, как писать инструкцию, приходится любому производителю. Традиционно эти обязанности возложены на так называемых технических писателей, хотя нередко ими также занимаются копирайтеры, менеджеры или аналитики компании.
Разнообразные инструкцию являются неотъемлемой частью контента любого информационно-практического сайта.
- 1 Какие бывают инструкции
- 2 Как правильно составить инструкцию
- 3 Работа с текстом и иллюстрациями
Какие бывают инструкции
Существует несколько классификаций данной документации. По содержанию инструкции делят на следующие виды:
- описательные – рассказ об особенностях товара, возможностях сервиса, полезных функциях, прочее;
- сценарные – пошаговые указания, как решить конкретную задачу, к примеру, как собрать стол, сварить суп или заменить термопасту на процессоре компьютера.
В сценарных инструкциях часто приводятся профессиональные хитрости, например, указываются горячие клавиши. Считать их банальным перечислением действий слишком поверхностно. Качественная сценарная инструкция обычно предоставляет и другую полезную информацию, при этом оставаясь в обозначенных рамках.
По формату инструкции принято делить на:
- текст;
- видео;
- инфографика;
- FAQ;
- скринкастинг.
Каждый из вышеперечисленных видов используется, исходя из особенностей продукта. К примеру, когда речь заходит о программном обеспечении, то идеальный вариант – скринкастинг (запись экрана) или видеоинструкции. В этом случае пользователю предоставляется наглядное руководство, как именно осуществить, скажем, установку или настройку ПО, причем непосредственно на реальном примере. Чаще всего используются текстовые инструкции в печатном и электронном виде, как наиболее универсальные и подходящие большинству физических товаров.
Как правильно составить инструкцию
Для начала нужно определиться с рядом важным особенностей, исходя из которых и выбирается формат данной документации и т.д. Так, перед тем какписать инструкцию, необходимо четко представлять целевую аудиторию и при каких именно обстоятельствах она будет изучаться пользователем. Иногда резонно разделить ее на два отдельных документа. В этом случае в одном будет приведена различная техническая информация, перечислены характеристики, указаны сведения о производителе и т.д., а в другом – показан пошаговый порядок действий.
Инструкция, как уже говорилось выше, нужна для всех товаров, однако она не обязательно должна быть слишком уж детальной. Если товар простой и общеизвестный, то логичнее ограничиться документом с кратким описанием, если же это новый продукт, который только выходит на рынок, то лучше рассказать о нем более подробно, не упустив никаких важных нюансов.
Большую роль играет и целевая аудитория. Если предполагается, что товар будет приобретать и использовать человек, который мог с ним раньше никогда не сталкиваться, то инструкция должна быть максимально простой, понятной и детальной. В случае, когда продукт ориентирован на профессионалов или людей с опытом работы с данным типом товаров, документацию резонно составить в несколько иной форме, так как рассказ «на пальцах» таким покупателям не нужен и априори не интересен.
Объемным инструкциям необходимо оглавление. Если документ содержит в себе порядка 10 и более страниц, то оно фактически обязательно. Без оглавления пользователю будет сложнее отыскать необходимую информацию, что сильно снижает полезность и, следовательно, качество инструкции, как таковой.
Работа с текстом и иллюстрациями
Оптимальнее всего писать инструкции, которые как бы вступают в диалог с читателем. При этом нужно учитывать несколько факторов. Так как инструкция является официальным документом, то в нем нет места личным суждениям, лирическим отступлениям от темы и прочее. Все это необходимо убрать.
Обратная сторона – упор в техническую составляющую, когда документ буквально пестрит сложными терминами. Это тоже нельзя назвать здравым решением. По возможности лучше использовать терминологию в разумных мерках, не забывая о том, какой именно покупатель в конечном итоге будет держать в руках данный продукт. Не исключено, что многие термины ему буду непонятны.
Глаголы нужно ставить в повелительном наклонении. Никаких «может», «наверное» и прочее. Также стоит осторожно обращаться с синонимами. Размышляя, как писать инструкцию, помните, что синонимы могут означать разные вещи и это лишь запутает читателя. Сленг, жаргон – тоже не к месту в официальном документе.
А вот что точно будет полезно, так это иллюстрации. Буквально парой картинок можно заменить объемное описание порядка действий, поэтому использовать их не только можно, но и нужно.
Источник: wpuroki.ru
Как написать хорошую инструкцию: 5 шагов, полезные советы, пример
Имя собственный ресурс, для привлечения постоянного и качественного трафика, требуется размещать на нем полезный и нужный целевой аудитории материал. Таким материалом, практически всегда, является хорошая инструкция.
Инструкция — это некие указания, правила и порядок действия, для достижения какой-либо цели. Таких статей в сети Интернет тысячи и все они несут некую полезную информацию.
Как написать инструкцию — это вопрос больше к самому себе, так как написание хорошей инструкции полностью зависит от владения темой самого автора, но также существует некий план по ее написанию, придерживаясь которого можно создать действительно полезный материал для своего сайта или на заказ.
Для чего нужна любая инструкция
Ответ на этот вопрос очевиден, но поскольку мы говорим с точки зрения автора, то, для чего нужна инструкция, нам нужно разобраться чуть детальнее.
- С точки зрения читателя — это решение его проблемы, в том или ином вопросе, в зависимости от тематики сайта, на котором она опубликована;
- С точки зрения заказчика (владельца сайта) — привлечения целевого трафика, а как следствие потенциальных клиентов;
- С точки зрения копирайтера — написание качественного текста, который принесет доход или упорядочит информацию в голове.
Но, всеже в конечном итоге, инструкцию будет читать человек, которому нужно что-то сделать, а значит она должна быть в первую очередь рассчитана именно на читателя. То есть, быть максимально полной, информативной, структурированной, пошаговой и главное решать проблему пользователя.
Какие бывают инструкции
Четких критериев и определений на то, какие бывают инструкции, вряд ли кто-то сможет дать. Это сугубо индивидуальная тематика и даже для решения одного и того же вопроса, инструкция может быть совершенно разной и подана в разных стилях, в зависимости от места размещения и контекста.
Но некоторой классификации, в общих чертах, инструкции всеже можно подвергнуть, и так какие виды инструкций бывают:
- Инструкция по строительству или сборке чего-либо;
- Инструкция по применению чего-либо;
- Медицинская инструкция;
- Инструкция из разряда «Как сделать…»;
- Инструкция по приготовлению пиши (рецепт);
Естественно, это далеко не весь перечень, даже самых распространенных видов инструкций, но наиболее известный — это точно.
Существует отдельный вид инструкций, я его называю «специфический», к нему можно отнести:
- Пошаговую инструкцию как написать книгу;
- Инструкцию как в домашних условиях сделать что-то для этого не предназначенное;
- Инструкция как вести себя в той или иной ситуации.
И аналогичные этому.
Как написать пошаговую инструкцию (самое интересное)
По сути, эта статья — инструкция как написать инструкцию, плюс неплохо заточенные под СЕО текст с ключами. То есть, структура, выделенные ключи и заголовке в этой статье — это уже первый пример инструкции.
Но, помимо всего, я все же расскажу начинающим копирайтерам, по какому плану следует идти, чтобы написать качественную инструкцию, гайд или свод правил:
- Найдите проблему — это очень важный этап. Кроме того, проблема, которую решит ваша инструкция должна полностью соответствовать тематике вашего сайта или сайта заказчика;
- Разобраться в вопросе — полностью, досконально и глубоко разобраться в вопросе, о котором будете писать инструкцию;
- Разбить решение проблемы на шаги — составе план, в котором первым пунктом будет наличие проблемы, а последним описание результата ее решения. Промежуточными же пунктами должны стать, последовательные, четкие, полные и грамотные шаги по достижению цели;
- Распишите более подробно каждый шаг — даже уже написав текст в него всегда есть что добавить. Пусть последовательность решения проблему будет максимально подробной;
- Схемы, картинки, примеры — добавьте в статью максимально доступную визуальную информацию. Ее должно быть немного, но в тоже время и не мало. Но помните, что не для всех инструкций такой ход необходим, как, скажем, в этой;
- Полезные советы — добавите вставки в текст с полезными советами (также не для всех видов инструкций);
И вот теперь, как написать инструкцию, образец плана выше, можно понять наглядно, но еще прочитав эту статью и хорошо ее проанализировав, можно понять, как написать СЕО-текст с определенной тематикой.
Вы пришли сюда из поиска? Это доказывает вышесказанное.
Как написать инструкцию: пример
Как я уже говорил выше, пример написания инструкции — это вся эта статья. Более того, большинство статей на этом сайте, которые начинаются со слова «Как» — являются инструкциями, в той или иной степени.
Повторюсь еще раз, классификации и стандарта по написанию инструкций не существует. Главное в написании такого материала — это подробное и пошаговое решение проблемы читателя. Если читающий разобрался со своей проблемой, то инструкция написана верно.
Источник: yourwriter.ru