В какой программе лучше писать инструкции. Как написать инструкцию с нуля

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

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

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

Зачем существуют инструкции: Что делать? и Кто виноват?

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

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

В действительности, единственное предназначение нормативного документа - ответить на вопрос исполнителя «Что делать?» перед началом работ и на вопрос руководителя «Кто виноват?» в случае, когда полученный результат не совпал с задуманным. Все остальное должно быть самым безжалостным образом вычищено из инструкции. Это первое правило .

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

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

Если это понятно, можно приступать к «чистке» документа. Исключите из должностной инструкции все призывы, пожелания, обороты типа «исполнитель обязан…», «исполнитель должен…». Все это лишнее. Должностная инструкция должна содержать как можно более простые предложения: «Он побежал…», «Она сделала…». Одно положение инструкции ничуть не менее важно, чем любое другое, поэтому нет необходимости подчеркивать некоторые из них красочными оборотами. Попробуйте выбросить этот мусор, и вы увидите, что нормативный документ становится процентов на 20 короче и намного яснее. Это второе правило .

Помните: вы пишете инструкции конкретным людям

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

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

Парадокс заключается в том, что для дворника и оператора на атомной электростанции должностные инструкции получатся почти одинаковой длины!

Цели, задачи, функции: от общего к частному

Итак, из нормативного документа следует исключить все необязательные эпитеты и призывы, а также все то, что исполнитель знает безо всякой инструкции просто в силу своего образования, квалификации и опыта. А что же там должно остаться?

Раздел 1 «Общие положения». Содержание этого раздела полностью определяется традициями каждой конкретной организации и практически не влияет на качество самого документа. Каждый юрист или кадровик имеет свое представление о том, как должен выглядеть этот раздел. Оставим его на их усмотрение. Отметим только, что этот раздел должен быть унифицирован во всех корпоративных документах. Если этого не будет, то значение приобретут не сами формулировки, а различия в них. Зачем вам это надо?

Раздел последний «Заключительные положения». То же самое.

Раздел 2 «Цели и задачи». С этого раздела собственно и начинается нормативный документ. Если общие и заключительные положения можно написать «на автопилоте» или просто позаимствовать из другого документа, то к «Целям и задачам» нужно приступать, четко понимая, зачем вообще вы взялись за этот документ. Следующий раздел «Функции» можно поручить составлять подчиненному, которому в будущем предстоит эти функции осуществлять, но «Цели и задачи» должен определить руководитель лично. Как бы ни был для него мучителен этот процесс, это и есть его основная работа.

Как правильно сформулировать цели?

Правило четвертое. Цели должны быть одного масштаба. Вспомните анекдот о собрании, где на повестке дня стояло два вопроса: 1) починка сарая и 2) строительство коммунизма. Подумайте, если вы пишете инструкцию строительства коммунизма, то зачем вам сарай? А если - починки сарая, то при чем коммунизм?

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

Правило шестое. Избегайте несвязанных или, еще хуже, противоположных целей.

И в заключение о целях: не бойтесь декларативных целей. Цель может быть в принципе недостижимой. Если воспользоваться аналогией с Боевым уставом, то цель - это то, что в боевом приказе на наступление называется «направлением дальнейшего движения». Важно, чтобы ваши подчиненные не перепутали тыл с фронтом, все остальное - детали.

Теперь о задачах.

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

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

Помните: формулируя задачу, вы тем самым определяете форму отчетности!

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

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

Раздел 3 «Функции» занимает по объему около 60 процентов всего документа. Это важнейшая часть нормативного документа. Однако, если вы правильно сформулировали цели и задачи, трудностей с описанием функций у вас не возникнет.

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

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

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

Правило десятое. Формулируя цели, задачи и функции, используйте одну и ту же конструкцию предложения. Пример из недавнего прошлого:

ускорение развития страны;

подъем трудовой активности масс;

формирование нового человека;

утверждение социалистического образа жизни.

Соответствующие задачи:

поднять благосостояние советских людей на качественно новую ступень;

обеспечить такие уровень и структуру потребления материальных, социальных, и культурных благ, которые…

Вытекающие из указанных целей и задач функции (действия):

намечается удвоить объем ресурсов, направляемых…

партия придает особое значение усилению…

предстоит осуществить комплекс мер…

будет проводиться линия на…

будет делаться все необходимое для…

будут продолжены ускоренный рост и совершенствование распределения…

партия считает задачей первостепенной важности…

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

партия считает делом особой социальной значимости ускорение решения жилищной проблемы и так далее.

Обратите внимание: цели сформулированы с помощью предложений с подлежащими-существительными без сказуемых-глаголов. Задачи сформулированы иначе - с использованием глаголов в неопределенной форме. При формулировании функций использовано несколько конструкций: «намечается/предстоит осуществить то-то и то-то», «будет сделано то-то и то-то», «партия считает важнейшим делом/задачей то-то и тот-то». Возможно, различия имеют под собой какую-то основу, а может быть, все это исключительно для красоты. Если вы пишете не новую программу КПСС, то лучше воздержитесь от лишних красивостей.

Почему важно придерживаться единого стиля? Да просто потому, что стилистический разнобой отвлекает инструктируемого, заставляет задумываться, а нет ли здесь скрытого смысла? Зачем забивать голову лишним - пишите проще!

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

Есть один технический прием. Включите в регламент рабочей операции раздел «Обязанности должностных лиц в связи с исполнением настоящего регламента». Аккуратно выпишите всех должностных лиц, упомянутых в разделах «Цели и задачи» и «Функции». Аккуратно распределите все функции между этими должностными лицами. Остались лишние функции, которые непонятно кто выполняет? Остались должностные лица, которым не досталось ни одной функции?

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

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

Реакций на нештатную ситуацию может быть только две: принять решение самому или доложить «по команде». Если вы не решаетесь прямо доверить подчиненному принимать определенные решения - не стесняйтесь включить в должностную инструкцию обязанность доложить о ЧП. Избавьте подчиненного от участи буриданова осла. Особенно важно обеспечить целостность регламента операции. Не поленитесь нарисовать блок-схему всего процесса. Убедитесь, что на каждой развилке есть четкое указание, что делать: передать работу дальше, вернуть обратно, направить в вышестоящую инстанцию или бросить в корзину для бумаг.

Мы рассмотрели двенадцать правил составления нормативных документов. Следование этим правилам сделает нормативные документы ясными, пригодными для использования в реальной жизни. Что касается краткости, то приведем пример. Автору пришлось анализировать инструкцию по кредитованию коммерческого банка. Исходный текст состоял из 13 026 слов или 92 187 символов. После обработки текст сократился до 6011 слов (42 246 символов).

Увы, проблема составления кратких и ясных нормативных документов не сводится к решению чисто технических вопросов. В большинстве случаев и заказчики, и авторы документов целенаправленно, хотя и бессознательно, «размывают» и «раздувают» должностные инструкции. Тем самым они создают определенный «люфт» в отношениях. И начальники, и подчиненные получают возможность маневрировать. Начальники избавляются от необходимости четко ставить задачи, подчиненные - безупречно их исполнять, и те и другие избавляются от необходимости отвечать за свою работу.

По материалам www.emsi.ru

Статья предоставлена нашему порталу
редакцией журнала

Существует множество видов предоставления справочной информации пользователю – это и FAQ (frequently asked questions, часто задаваемые вопросы) и онлайн справка и руководство пользователя (user guide) и популярные сегодня подсказки (coachmarks, см. пример ниже), обучающие видео и другие.

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

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

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

1. Стандарты

Часто бывает нужно написать документ, который бы удовлетворял требованиям действующих стандартов. Это могут быть:

IEEE Std 1063-2001, «IEEE Standard for Software User Documentation»;
ГОСТ 19:
- ГОСТ 19.402-78 ЕСПД. Описание программы;
- ГОСТ 19.502-78 ЕСПД. Общее описание. Требования к содержанию и оформлению;
- ГОСТ 19.503-79 ЕСПД. Руководство системного программиста. Требования к содержанию и оформлению;
- ГОСТ 19.504-79 ЕСПД. Руководство программиста. Требования к содержанию и оформлению;
- ГОСТ 19.505-79 ЕСПД. Руководство оператора. Требования к содержанию и оформлению.

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

Также может оказаться полезной книга Юрия Кагарлицкого MetaGuide. Руководство для разработчиков технической документации к программному обеспечению.

2. Структура

Хорошо продумайте структуру документа: она должна покрывать все функциональные возможности системы, быть полной и понятной.

Хорошее руководство пользователя должно содержать:

Аннотацию , в которой приводится краткое изложение содержимого документа и его назначение. Также рекомендуется писать краткую аннотацию в начале каждого крупного раздела.
Введение , содержащее информацию о том, как лучше всего использовать данное руководство
Содержание
Главы , описывающие, как использовать ПО
Глоссарий и
Предметный указатель

Также руководство пользователя может содержать:

FAQ и ответы на них
Ссылки на дополнительную информацию по системе
Раздел , описывающий возможные проблемы и пути их решения

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

3. Пользователи

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

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

Уважайте пользователей системы, не пишите инструкции в пренебрежительном стиле.

4. Особенности изложения

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

Стиль руководства должен быть нейтрально-формальным – использование стилистически окрашенных слов отвлекает пользователя от сути.

Для составления хорошего документа пригодятся знания грамматики и немного психологии.

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

Хорошо : In File menu, select Save item .
Хуже : Select Save item from File menu.

4.2 Используйте повелительное наклонение , не употребляйте вежливые обороты (please, could и т.д.) — излишняя вежливость именно здесь будет помехой.

Хорошо : Click Logout .

Хуже : It is needed to click Logout to log out current user account from the system.

Хуже : If user wants to log out current user account from the system(s)he needs to click Logout.

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

Хорошо:
To create project :

Click the Create button on toolbar.
On the Create Project overlay fill in all mandatory fields.
Click the Save button to save the project.

Хуже : To create project click the Create button on toolbar, on the Create Project overlay fill in all mandatory fields, click the Save button to save the project.

4.4 Не используйте будущее или прошлое время . Например, часто встречаются руководства, в которых реакция системы на действие пользователя передается фразами, сформулированными в будущем времени. У ПО нет прошлого или будущего: всё случается в настоящем как прямой результат конкретного действия пользователя. Как только событие случается, ПО реагирует.

Хорошо : When user clicks the Start button, the program starts the process.

Хуже : When user clicks the Start button, the program will start the process.

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

Например, глагол «press» означает нажатие клавиши на клавиатуре, а «click» – нажатие кнопки или значка в окне программы при помощи мыши, а «hit» вообще является жаргонным словом.

Разумеется, орфографические ошибки недопустимы.

4.6 Не используйте синонимы для одного и того же термина. В IT литературе на английском (или любом другом) языке есть стандартный набор глаголов, обозначающих действия (click, double-click, select, type, press и т.д.) и такой же стандартный набор названий элементов управления. Определитесь с терминологией и придерживайтесь ее в рамках всего документа.

Например, не допускайте, чтобы в одной части документа выпадающий список назывался dropdown, а в другой точно такой же элемент – combobox или dropdown list. Это путает пользователя.

4.7 Разумно используйте сокращения и исключите жаргон .

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

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

5. Внешний вид

5.1 Продумайте стиль документа . Это может быть корпоративный шаблон или цветовая схема ПО или специально сделанный для документа дизайн.

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

5.2 Не экономьте место – разбивайте текст на короткие абзацы, используйте сравнительно крупные заголовки, начинайте новый раздел с новой страницы. Это облегчит восприятие прочитанной пользователем информации.

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

6. Поддержка

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

Заключение

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

Помните главное: документ должен помогать пользователям.

Статью подготовила

Тарасюк Надежда, участник сообщества сайт,

аналитик с 6-летним опытом в сфере.

Определите, для кого готовится инструкция.

Вы пишите для новичков, профессионалов или для кого-то со средними знаниями?
Вашу инструкцию будут использовать на групповых занятиях или для самостоятельного изучения?

Точно определите, о чем будет сказано в инструкции.

Пример: Вы готовите руководство «Как установить двери». Один раздел может быть посвящен дверям-купе, другой – входных дверям, еще один – дверям для черного входа.

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

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

В глоссарии нужно использовать максимально точные описания терминов. Если используется акроним, объясните его значение (например, Scuba – «Self Contained Underwater Breathing Apparatus» автономный аппарат подводного дыхания).

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

Подумайте об организационной структуре каждого раздела.

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

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

Приступайте к написанию! Используйте организационную систему, как основу, но можете смело модифицировать ее, чтобы полнее раскрыть тему.

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

Внесите изменения, чтобы облегчить читателю поиск необходимой информации.
1. Пример 1: (Используйте нумерованный список) В редакторе можно привязать рисунок к пункту 13-му параграфу инструкции.
2. Пример 2: (Сортировка) В редакторе можно увеличить размер текстовой строки, если она выделяется из общего порядка.

Не списывайте чужие инструкции! Используйте указатели и список литературы, указывая, откуда заимствована цитируемая информация (другие авторы, инструкции и т.д.).

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

Добавьте соответствующие иллюстрации. Расположите их в тексте. Не бойтесь оставлять пустое пространство.

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

- Лучший, по нашему мнению, порядок проверки готовой инструкции:
  1. Вычитайте ошибки самостоятельно.
  2. Попросите друга проверить ошибки.
  3. Дайте работу на проверку специалисту в данной области, чтобы он также проверил ее.
  4. Если инструкция готовится для вашей компании, попросите начальника проверить ее.
  5. Дайте работу на проверку новичку.
  - Проверка неопытным специалистом поможет понять, насколько понятно изложен текст для людей, у которых в данной области минимум знаний.

Правильно ли написание кавычек: С 1 марта введена в действие инструкция «По организации безопасного проведения огневых работ в подразделениях ОАО «Ангарская нефтехимическая компания»»?


	Вопрос № 238647

Какой предлог должен быть употреблен при существительном "инструкция " - "при", "по" и т.д.? И можно-ли обходиться вообще без предлога?