25.08.2014 |  support@ida-web.ru

На что стоит обращать внимание при составлении инструкций?

Составление инструкций может оказаться весьма непростым делом для начинающих людей, несмотря на кажущуюся простоту этой задачи. Так, например, даже простейшая инструкция на 5-10 пунктов может оказаться бесполезной для людей, которые будут ее использовать. Сомневаетесь? Тогда внимательно читайте статью.

 

Проверяйте все ли учтено в инструкции и сможет ли по ней любой человек добиться результата

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

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

 

Учитывайте специфику людей, которые будут использовать вашу инструкцию

Еще одной из часто совершаемых ошибок является написание инструкций без учета специфики людей, их знаний и опыта. И речь идет не только об очевидных вещах, которые за года стали таковыми для вас. Показательный пример. Многие CMS поддерживают свою терминологию. Конечно, во многом, эти терминологии схожи, однако, это не всегда так и это необходимо учитывать. Например, в WordPress в основном все делится на виджеты и плагины, а в Joomla на компоненты, модули и плагины. И несмотря на наличие одного и то же слова "плагин", под этим термином подразумевается разное.

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

 

Предлагайте альтернативные варианты решения

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

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

Примечание: Конечно, если в системе произошел сбой реестра или прочие неполадки, то стоит заняться поиском причин и их починкой. Но, вы должны понимать, что это не всегда возможно (например, просто нет времени).

 

Описывайте исключительные ситуации

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

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

 

Копируйте информацию с источников

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

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

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

 

Не экономьте на фразах и уточнениях

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

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

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

Примечание: К примеру, есть системы, чья лишь одна установка описана на 70-100 страницах. И даже в этих инструкциях чувствуется нехватка уточнений и деталей.

 

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

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

 

Компания "Ida-Web.Ru" надеется, что данный материал поможет вам лучше понимать специфику мира информационных технологий.



Так же советуем

Обратная связь

Я согласен с вашими правилами и условиями

Опыт Знания Умения