Как сделать инструкцию: Как написать хорошую инструкцию: 5 шагов, полезные советы, пример

Возможно, это инструкция как это сделать.

Мы дали им инструкции, как сделать оригами, и мы дали имлист бумаги.

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

Мы дали им инструкции, как сделать оригами, и мы дали им лист бумаги.

Более подробно об этом, а так же инструкцию, как это сделать, Вы можете увидеть на нашем форуме.

Этот код также будет отправлен Вам по e-mail вместе с инструкциями о том, как сделать банковский перевод.

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

Пример эвристического искусства или серию инструкций как приобрести эстетический опыт.

Ответ: Воспользуйтесь инструкцией — как открыть счет у брокера.

Компиляторы могут также переупорядочить инструкции как часть оптимизации программы.

Я дала Марку точные инструкции как провести съемку моего Нового Амстердама.

На указанный Вами адрес электронной почты будет отправлена инструкция как подтвердить заказ.

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

Каждому из вас необходимы инструкции как взаимодействовать со взрослыми.

Я могу вам дать пояснения и инструкции как показывать эти суммы в отчетности.

Я нарисую тебе карту и инструкции — как тебе выключить вентель.

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

как сделать любое объяснение понятным

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

Шаг 1. Выясните уровень слушателей. Это очень важно. Дело в том, что все мы страдаем от так называемого «проклятья знания». Нам трудно представить, что другие люди не имеют сведений, которыми мы обладаем. Если вы специалист в своей области, какие-то вещи вам кажутся очевидными. Но это не значит, что они доступны для других людей. Например, редактор издательства прекрасно знает, как организована работа над выпуском книги, но, скажем, коммерческому директору трубопрокатного завода это неизвестно. Всегда подходите к оценке уровня аудитории с той позиции, что у слушателей нет ваших специфических знаний о проблеме, о которой вы собираетесь рассказать.

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

Шаг 3. Разожгите пламя любопытства. А вот теперь призовите на помощь свою фантазию. Теперь вы точно будете говорить о чем-то новом — и так, чтобы люди задались вопросами «почему?» и «как?». В этот момент вы можете вводить в рассказ новую информацию, но только так, чтобы в слушателей проснулось любопытство. Поддерживайте интригу и стимулируйте естественное стремление к познанию.

Шаг 4. Одну за другой приведите концепции. Понять основную идею невозможно, не разобравшись с частями (концепциями), из которых она состоит. На этом этапе у аудитории должны последовательно появляться вопросы «что?», «и что?», «и что дальше?».

Шаг 5. Используйте метафоры. Аналогии помогают усвоить новую информацию. Чтобы они были удачными и понятными, опирайтесь на близкие слушателям факты. Метафоры должны происходить из модели мира, свойственной вашей аудитории.

Шаг 6. Используйте примеры. Короткие и яркие истории помогают закрепить объяснение. А как их рассказывать с максимальным успехом, мы уже обсудили.

Подробнее о том, как построить свою речь, чтобы достучаться до любого слушателя, читайте в обзоре книги Криса Андерсена «TED Talks. Слова меняют мир: первое официальное руководство по публичным выступлениям».

как делегировать разработку инструкций своим подчинённым

Первое правило любого правила: Прочитать инструкцию или составить ее!

Неизвестный

кому: руководителям, топ-менеджерам, собственникам

Потаённая мечта руководителя

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

Ну чем не мечта руководителя? О том, имеют ли эти фантазии отношение к реальности, я и расскажу.

«В предыдущих сериях…» или «Ещё раз, почему регламенты и алгоритмы выгодны руководителю»      

В предыдущей статье “Система регламентов в компании как краеугольный камень эффективности руководителя” я подробно описал преимущества наличия системы регламентов. Повторение — мать учения. Поэтому привожу краткое содержание предыдущих серий.

Если сотрудник получает задание, которое он НЕ знает, “как выполнять” возможны два сценария:

• Сделает “хрен знает как”.
• Начнет всех спрашивать и отвлекать.

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

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

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

Ниже я привожу выдержки из алгоритма по составлению регламентов “Открытой Студии”. Копируйте, вносите “поправку на ветер” и внедряйте у себя в компании. Пристегнули ремни? Тогда поехали!

Алгоритм «Открытой Студии» по составлению регламентов

Как и что необходимо регламентировать

Если Вы столкнулись с проблемой / задачей, и предсказуемо, что она может повторяться в дальнейшем — значит она должна быть Вами регламентирована!

Любая повторяющаяся задача должна быть Вами регламентирована!

Запишите проблему в специальную таблицу “Лист разработки / дополнений регламентов «Открытой Студии»” и сообщите о ней исполнительному директору. (сотрудник может самовольно приступить к реализации только для инструкций, за которые он ответственен).

Мелкие и некритичные недочёты могут быть отмечены с помощью комментариев в соответствующем документе регламента (только для регламентов в GoogleDocs).

Критерии хорошего регламента

Регламент должен быть написан языком “блондинки”, т.е. как можно более наглядным. Желательно сопровождаться скриншотами.

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

Не забыть внести поправки в регламенты, находящиеся “сверху”, “снизу” и “сбоку” (изменился процесс у смежного объекта).

Если есть идея значительного изменения регламента, то для её оценки можно воспользоваться методикой “сплав по реке”:

• “Пройти вниз” по всем инструкция и определить последствия планируемых изменений.
• Если всё “ОК”, то обновить все смежные регламенты. Желательно, чтобы изменения вступили в действие в один день.

Алгоритм написания пошаговой инструкции

1. Описать инициирующее событие.
2. Описать процедуры и операции в верном порядке (используем принцип “Декомпозиции”)

• Процедура: единство времени и действия, одна цель (пример для продавца киоска: отпереть киоск утром, отмазаться от проверяющего и т.д.). Состоит из операций.
• Операция: отключение сигнализации, отпирание входной двери и т.д. (единичное действие).

• Необходимо проставлять кросс-ссылки на другие документы (см. ниже “Разделение регламентов и ссылки на дополнительные регламенты”).
• Использовать уже готовые регламенты и ссылаться на них, а не копировать их содержимое (чтобы избегать одновременного внесения изменений в 2 и более документа одновременно).

• Японское правило: “Одна картинка стоит тысячи слов”
• Снабжайте регламент поясняющими скриншотами, иллюстрациями, картинками, фотографиями, схемами, образцами бланков, видео-инструкциями.
• Выстраивать “Цепочки контроля” (если подразумевается, что работу выполняют последовательно несколько людей, и кто-то получает на вход результаты от другого)
• Каждый сотрудник, начиная со второго и дальше, перед тем как выполнить свою работу, проверяет работу выполненную перед ним.
• Кого необходимо наказывать в случае обнаружения “брака”? Ответ: того, кто допустил брак / косяк, и того, кто его работу не проверил.

• Кому подчиняешься ты, кто подчиняется тебе.

Методика проверки инструкции исполнительным директором

• Проверить соблюдение “Правила оформления регламента” (см. ниже).
• Выполнить то, что описано в инструкции, либо посадить перед собой человека-тестера (который желательно никогда в жизни эту работу не делал) и рядом с ним наблюдать за всеми его косяками и вопросами. Фиксировать всё. По итогам поставить задачу на доработку инструкции либо дополнить её самому.

Ввод в действие регламентов

Правила оформления регламента

• Для каждого регламента необходимо создать автоматическое оглавление (в GoogleDocs: “Insert” → “Table of contents”)
• Частицу “не” необходимо писать большими буквами и выделять жирным, получится: “НЕ” 
• Соблюдать иерархию в заголовках <h2> — <h6>, заголовок <h2> должен быть только один на весь документ — и это название регламента.
• Между предыдущим абзацем текста и следующим за ним заголовком ставить пустую строку (между заголовком и следующим за ним текстом — НЕ надо). 
• Текст под заголовками начинать с маркированного списка. Не пренебрегайте и другими правилами по улучшению читабельности текста.
• Если размещается скриншот, то
• он должен сразу следовать за информацией, которую он поясняет.
• в конце последнего предложения перед скриншотом должна быть фраза “(см. скриншот ниже, возможно, скриншот перенесён на следующую страницу документа”)
• если скриншот большой, то он переносится на следующую страницу и создаётся впечатление, что дальше текста нет)
• После каждого дополнения регламента необходимо прокручивать вверх и нажимать на кнопку “обновить оглавление”.

Ветвление регламентов и ссылки на дополнительные регламенты (на примере сервиса Google Docs)

Если информация переносится из одного регламента в другой, то необходимо оставить основной заголовок + надпись наподобие “Все вопросы по заключению договоров см. документ “Работа c договорами и официальными документами в «Открытой Студии»”.

Правила работы с кросс-ссылками в регламентах

• установка локальных ссылок в документе
• выделить заголовок, на который планируешь ссылаться
• выбрать в верхнем меню “Insert → Bookmark”
• перейти на место, откуда будешь ссылаться в том же документе
• выделить анкор (текст ссылки) и выбрать “Insert → Link → Bookmarks”.
• установка глобальных ссылок на другие документы
• Необходимо использовать текст (анкор) для ссылки, а не постить url-ссылки.
• в качестве текста ссылки необходимо взять название документа + заголовок, на который будет переход в другом документе.
• для того чтобы в документе, куда ведёт ссылка, произошёл переход именно в нужно место, необходимо в нём сначала кликнуть по искомому заголовку в оглавлении и только после этого можно скопировать эту ссылку из строки браузера для вставки.
• Кстати, глобальные ссылки в GDocs при перемещении документов между папками и переименовании документов СОХРАНЯЮТСЯ.

Разработка шаблонов документов

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

• Решение о разработке шаблона документа Сотрудник согласовывает с исполнительным директором, как и сам итоговый результат на выходе.
• Самостоятельное изменение существующих шаблонов документов запрещается без согласования планируемых правок с исполнительным директором.
• Если возникла идея дополнить шаблон, то её надо записывать в специальную таблицу “Лист разработки / дополнений регламентов «Открытой Студии»” и после этого обсуждать с исполнительным директором:
• Все новые документы необходимо создавать на основе шаблонов, а НЕ на основе аналогичных документов, разработанных ранее. Так как шаблон постоянно дорабатывается, то он всегда актуальнее.

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

Рекомендуемые услуги «Открытой Студии»

Как сделать пошаговую инструкцию LEGO (создание инструкции в LPub)?

В первой статье мы научились создавать виртуальную модель с помощью программ MLCad и LSynth. В этой второй статье мы рассмотрим, как создать полноценную пошаговую инструкцию по сборке робота LEGO Mindstorms Education EV3 с помощью программы LPub.

Первая статья «Как сделать пошаговую инструкцию LEGO (создание модели в MLCad + LSynth)?» описывает, как установить программы MLCad, LSynth и LPub и как создать вигруальную модель вашего робота в программах MLCad и LSynth.

Подготовка проекта к публикации в LPub

Публикация готового проекта или, другими словами создание инструкции, делается с помощью программы LPub. На выходе у вас будет файл PDF или набор картинок оформленных в стиле инструкций LEGO. Посмотрим, как работать в программе LPub. Для примера я сделал простой проект со средним мотором, модулем EV3, проводом, созданным в программе LSynth, и с подпроектом.

Запустите LPub и откройте ваш проект. После открытия вы сразу видите первую страницу будущей инструкции с изображением первого шага.

Сразу разберёмся с интерфейсом программы. В основном пространстве окна программы отображается лист с текущим шагом будущей инструкции. Справа вы видите файл проекта в текстовом виде с подсветкой разными цветами. В этом текстовом редакторе можно менять проект и после этого, чтобы увидеть сделанные изменения в инструкции нужно нажимать кнопку «Redraw» (кнопка с закрученной стрелкой над текстом проекта — ).

Чтобы перемещаться между страницами, щёлкайте по жёлтым стрелочкам или вбивайте номер страницы в текстовом поле между стрелками «1 of 6», где вместо единицы вводите нужную страницу.

Первое, что нужно сделать, при создании инструкции, — это задать параметры страницы. Окно настройки параметров страницы вызывается из меню «Configuration -> Page Setup». Чтобы задать страницу размером A4 в портретном режиме, указываем размеры 21×29,7 см, см. картинку. Чтобы повернуть страницу в альбомный режим – просто поменяйте эти значения местами. Поля (Margins) влияют на расстояние, на котором от края листа будут расположены номера шагов и страниц.

Здесь же можно указать будет ли рамка у страницы, какого она будет цвета, формы и ширины. А также задать цвет фона страницы. По умолчанию цвет фона устанавливается разным для разных уровней (Submodel Level Color). Под уровнями имеются ввиду используемые подпроекты. Ведь в каждом подпроекте могут использоваться другие подпроекты, это и есть уровни. Т.е. фон для основного проекта – будет белым, для подпроекта – жёлтым, для подпроекта подпроекта – розовым, и.т.д. На закладке «Page Number» можно задать параметры отображения номера страницы (местоположение, шрифт, размер, цвет и т.п.).

Кроме того в меню вы можете найти настройки финальной сборки («Configuration -> Assembly Setup»), списка деталей для шага («Configuration -> Parts List Setup») и списка деталей всего проекта («Configuration -> Bill of Materials Setup»), выносок («Configuration -> Callout Setup»), группы шагов («Configuration -> Step Group Setup») и настройки проекта («Configuration -> Project Setup»). В статье я не буду рассматривать эти настройки.

Также вы сможете настраивать каждый элемент отдельно от общих настроек. Например, чтобы настроить внешний вид списка деталей первого шага, щёлкните по пустому пространству списка деталей и вы увидите пункты меню для изменения фона («Change Parts List Background»), рамки («Change Parts List Border») и отступов («Change Parts List Margins»).

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

Выравнивание элементов в LPub

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

В диалоге «LPub: PLI Placement Dialog» в выпадающем списке слева сверху вы можете выбрать элемент к которому вы будете привязывать ваш список деталей (как видите, сейчас это номер страницы – Step Number). Также список деталей можно привязать к странице (Page), схеме сборки (Assem), номеру страницы (Step Group). Остальные кнопки обозначают местоположение относительно выбранного элемента.

Попробуем привязать список деталей к правому верхнему углу страницы. Для этого в списке выберите «Page» и щёлкните по кнопке «Top/Right» (Сверху/Справа), см. картинку. Нажмите «OK».

В следующем диалоге, если он появился, нажмите «Yes», если вы меняете только этот шаг или «No», если нужно изменить настройки всего проекта.

И как вы видите, список переместился в верхний правый угол страницы.

Создание группы шагов в LPub

В моём примере шаги 1 и 2 очень малы и могут поместиться на одну страницу. Сгруппировать шаги на одной странице очень просто. Щёлкните правой кнопкой мышки на модели и выберите пункт меню «Add Next Step».

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

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

Таким образом, на страницу можно добавить любое количество шагов. Если какой либо шаг нужно убрать обратно из группы, щёлкните по нему правой кнопкой мышки и выберите пункт «Remove this Step».

Если листы вашего проекта ориентированы альбомно, то вам может понадобиться расположить шаги не друг под другом, а рядом. Чтобы это сделать, щёлкните по модели любого шага правой кнопкой мышки и выберите пункт меню «Display as Rows».

Отображение больших моделей в LPub

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

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

Как видите, проблема налицо: модель сдвинулась, но осталась подрезанной. Давайте разберёмся, почему так происходит. Дело в том, что для формирования картинки с изображением модели используется программа LDView, которая всегда размещает модель по центру и обрезает края, которые не влезли. Картинки, заготавливаются автоматически и складываются в папку LPub\assem в той же папке, в которой находится файл проекта . ldr. После этого программа LPub просто подставляет картинки на лист. Чтобы картинки не подрезались, нужно выполнить следующую последовательность действий:

1. Откройте проект. Если проект открыт, то сохраните проект.
2. Увеличьте размер страницы, чтобы модель помещалась целиком, например, в 2 раза по ширине и в 2 раза по высоте.
3. После этого запустите создание PDF-файла (пункт меню «File -> Print to File»). При этом пересоздадутся все картинки модели.
4. Не закрывая LPub, скопируйте созданные картинки из папки LPub\assem в какую-нибудь временную папку.
5. Теперь закройте LPub без сохранения изменений.
6. Найдите нужные необрезанные картинки во временной папке, имена файлов должны быть следующими: filename_*_a_xxxx_yyy_DPI_*.png, где

filename – имя файла вашего ldr-файла;
* — множество нулей и единиц с подчёркиваниями;
a – номер шага;
xxxx – ширина страницы в дюймах умноженная на DPI;
yyy – значение DPI.

7. Переименуйте нужные файлы во временной папке, заменив xxxx на произведение ширины страницы в дюймах и значение DPI (в примере — 150) с отброшенной дробной частью. DPI (Dots Per Inch) – количество точек в дюйме, но в моём примере – это количество точек в сантиметре. Узнать или поменять эту величину можно в настройках: пункт меню «Configuration -> Project Setup». В примере ширина страницы 21 см, в результате получится так: 21/2,54*150=1240,157480314961. Отбрасываем дробную часть и получаем 1240.
8. Скопируйте готовые файлы из временной папки в папку LPub\assem и сделайте их доступными только для чтения (в эксплорере пункт контекстного меню «Свойства», в диалоге свойств файлов установите галочку «Только чтение» и закройте диалог, нажав «OK»).
9. Всё готово. Запустите LPub, откройте проект и проверьте результат.

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

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

У данного способа, кроме неудобства есть ещё один недостаток, который вы заметите, листая страницы вашего проекта – это низкая скорость отрисовки таких изменённых страниц.

Описанный здесь способ использовался в последних шагах в инструкции по сборке робота Валли.

Отображение проводов в LPub

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

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

Дальше находим этот файл в папке с деталями программы LSynth (по умолчанию – это папка C:\Users\Public\Documents\LDraw\Unofficial\LSynth) и копируем его в папку, в которой находится файл проекта .ldr. После этого перезапустите LPub. Как видите, провод появился.

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

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

0 LPUB PLI BEGIN SUB 11145.dat 15
0 !LPUB PART BEGIN IGN

а в конце строки

0 !LPUB PART END
0 LPUB PLI END

При этом уберите лишние строки «0 LPUB PLI BEGIN SUB 4297187. dat 16» и «0 LPUB PLI END», которые были автоматически установлены программой LSynth. В общем-то, нужно проверить, что на один провод у вас одна строка «0 LPUB PLI BEGIN SUB …» в начале и одна строка «0 LPUB PLI END» в конце. При этом вилки, тоже должны попасть внутрь строк «0 !LPUB PART BEGIN IGN» и «0 !LPUB PART END».

Здесь строки «0 !LPUB PART BEGIN IGN» и «0 !LPUB PART END» сообщают программе LPub, что всё находящееся между ними нужно игнорировать при формировании перечня деталей. А строки «0 LPUB PLI BEGIN SUB 11145.dat 15» и «0 LPUB PLI END» сообщают, что всё, что находится между ними – это деталь 11145.dat, т.е. провод EV3 длиной 25см. Чтобы в списке деталей отображался нужный провод, пропишите в строке «0 LPUB PLI BEGIN SUB 11145. dat 15» имя файла с нужным вам проводом (имя файла можно узнать, например, в программе MLCad: имя подсвечивается в статусной строке, если навести мышку на деталь в области 3, см. «Интерфейс программы MLCad» в начале первой статьи). Для провода EV3 25см – это файл 11145.dat, 35см — 11146.dat, 50см — 11147.dat.

Ещё небольшое замечание по поводу цвета вилок. В примере я сделал их белыми (номер цвета 15), но вы можете для большей схожести с настоящими вилками сделать их полупрозрачными, выставив, например, цвет Glitter_Trans_Clear, номер цвета — 117. Т.е. для прозрачности вместо цифры 15, нужно поставить 117.

В результате у вас должно получиться примерно вот так:

0 LPUB PLI BEGIN SUB 11145.dat 15
0 !LPUB PART BEGIN IGN
1 15 127 -64 -216 -1 0 0 0 -1 0 0 0 1 933c01.dat
1 15 28 18 -150 1 0 0 0 -1 0 0 0 -1 933c01. dat
0 LPUB PLI BEGIN SUB 4297187.dat 16
0 SYNTH BEGIN PLI_ELECTRIC_NXT_CABLE_20CM 16
0 SYNTH SHOW
0 MLCAD HIDE 1 2 28 18 -151 1 0 0 0 0 -1 0 1 0 LS05.dat
0 MLCAD HIDE 1 14 42.492 -10.358 -192 -0.965926 -0.258819 0 -0.258819 0.965926 0 0 0 -1 LS05.dat
0 MLCAD HIDE 1 14 68.2 -47.416 -147 0 0 1 -1 0 0 0 -1 0 LS05.dat
0 MLCAD HIDE 1 14 82.765 -67.994 -85 -0.866025 -0.5 0 -0.5 0.866025 0 0 0 -1 LS05.dat
0 MLCAD HIDE 1 14 118.264 -92.564 -134 -0.965926 0 -0.258819 -0.258819 0 0.965926 0 1 0 LS05.dat
0 MLCAD HIDE 1 4 127 -64 -199 1 0 0 0 0 -1 0 1 0 LS05.dat
0 SYNTH SYNTHESIZED BEGIN
1 0 28 18 -151 0.9999 0.0575 -0 0 -0.0269 -1 0.0141 -4.0722 0.0066 LS12.dat
1 0 28.0507 17.9763 -154.59 0.9841 0.1327 -0.173 -0.1723 -0.0696 -0.9848 0.0435 -3.2756 0.0139 LS12.dat
1 0 28.1659 17.9159 -157.433 0.9497 0. 1699 -0.3068 -0.305 -0.0983 -0.9517 0.071 -2.6959 0.0154 LS12.dat

…

1 0 126.76 -64.7843 -189.705 0.995 0.1733 -0.0879 -0.0942 0.5723 -0.9834 0.0325 -3.6441 -0.1586 LS12.dat
1 0 126.862 -64.4527 -191.805 0.9998 0.1472 0.0006 -0.0006 0.4936 -0.9981 0.0185 -7.9414 -0.062 LS12.dat
0 SYNTH SYNTHESIZED END
0 SYNTH END
0 !LPUB PART END
0 LPUB PLI END

После изменения текста проекта, перерисуйте страницы, щёлкнув по кнопке «Redraw» . После перерисовки вы можете удостовериться, что всё получилось.

Добавление выносок в LPub

Следующий шаг, который показывает сборку пропеллера и находится в подпроекте, слишком мал и его можно добавить в качестве выноски, чтобы не занимать целую страницу. Чтобы сделать выноску, щёлкните по пустому пространству страницы подпроекта правой кнопкой мышки и выберите пункт «Convert to Callout» (Конвертировать в выноску).

Как видите всё просто. Выноска добавилась, но расположение получилось не совсем удачное.

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

Чтобы убрать выноску, если вы передумали, щёлкните по пустой части выноски правой кнопкой мышки и выберите пункт меню «Unpack Calluot».

Борьба с игнорированием пустых шагов в LPub

По умолчанию LPub показывает только те шаги на которых добавляются детали. Но иногда бывает необходимо показать нашу модель с разных сторон. Чтобы заставить LPub показать шаг, на котором детали не добавляются нужно сделать запись в буфер и чтение из него. Для примера приведу часть проект, в котором всего три шага, причём третий шаг абсолютно такой же, как и второй, — это просто взгляд на модель с другой стороны.

1 15 -37 4 -38 1 0 0 0 1 0 0 0 1 32348.dat
1 1 -37 -16 -18 0 1 0 -1 0 0 0 0 1 6558. dat
0 ROTSTEP 45 -60 0 ABS
1 15 -17 -16 -18 0 0 -1 0 1 0 1 0 0 32348.dat
0 STEP
0 ROTSTEP 87.6316 7.11462 0 ABS

Для этого проекта программа LPub сделала две страницы для шагов 1 и 2, а 3-й шаг игнорируется. Чтобы заставить программу LPub показать третий шаг, добавляем в конце второго шага строку «0 BUFEXCHG A STORE» (запись в буфер A) и в третий шаг добавляем строку «0 BUFEXCHG A RETRIEVE» (чтение из буфера A). В результате у нас получится так:

1 15 -37 4 -38 1 0 0 0 1 0 0 0 1 32348.dat
1 1 -37 -16 -18 0 1 0 -1 0 0 0 0 1 6558.dat
0 ROTSTEP 45 -60 0 ABS
1 15 -17 -16 -18 0 0 -1 0 1 0 1 0 0 32348.dat
0 BUFEXCHG A STORE
0 STEP
0 BUFEXCHG A RETRIEVE
0 ROTSTEP 87.6316 7.11462 0 ABS

После изменения проекта перерисуйте страницы кнопкой «Redraw»  и вы увидите, что страниц и шагов стало по 3.

Добавление страниц в LPub

LPub позволяет добавлять в инструкцию страницы с произвольным содержанием. Для добавления страниц воспользуйтесь пунктами меню «Edit -> Insert Page» (добавление страницы перед текущей), «Edit -> Append Page» (добавление после текущей), «Edit -> Insert Cover Page» (добавление обложки в начало), «Edit -> Append Cover Page» (добавление обложки в конец). Разница между обычной страницей и обложкой в том, что обложка может быть добавлена только в начало или в конец инструкции и на ней не будет проставляться номер страницы. На добавленную страницу можно добавлять картинки, текст и полный список деталей. Удалить такую страницу можно щёлкнув по меню «Edit -> Delete Page».

При добавлении нескольких страниц я столкнулся с одним неприятным глюком: одна страница добавляется нормально, но все следующие — нет. При этом в текст проекта добавляются строки «0 !LPUB INSERT PAGE». Лечится это следующим образом: установите перед каждой строкой «0 !LPUB INSERT PAGE» строку «0 STEP». Например, три пустые страницы будут выглядеть вот так:

0 STEP
0 !LPUB INSERT PAGE
0 STEP
0 !LPUB INSERT PAGE
0 STEP
0 !LPUB INSERT PAGE

После изменения проекта перерисуйте страницы кнопкой «Redraw» .

Добавление текста и произвольных картинок на страницы в LPub

Добавить произвольные картинки и текст очень просто. Для этого есть пункты меню «Edit -> Add Picture» (для добавления картинки) и «Edit -> Add» (для добавления текста). Добавленную картинку можно увеличивать, уменьшать и передвигать по странице. Текст тоже можно двигать по странице и, кроме того, можно поменять шрифт и цвет. Для удаления картинки или текста, щёлкните по ним правой кнопкой мышки и выберите пункт меню «Delete this Picture» или «Delete This Text».

Добавление полного списка деталей в LPub

В конце или в начале инструкции вы можете захотеть добавить список всех деталей, использованных для создания модели. Сделать это можно на любой странице щёлкнув по пункту меню «Add -> Bill of Materials». Вот результат вставки полного перечня деталей на страницу для нашего тестового проекта.

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

Как разбить список деталей на несколько страниц в LPub?

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

1. Вставьте на страницу список материалов.
2. Увеличьте высоту списка. Я рекомендую сделать высоту списка чуть меньше чем высота страницы, и чтобы список не закрывал номер страницы.
3. Увеличьте ширину страницы (пункт меню «Configuration -> Page Setup») так, чтобы весь список уместился на странице.
4. Экспортируйте проект как набор картинок PNG (пункт меню «File -> Export As… -> Export As PNG Images») во временную папку.
5. Найдите картинку со страницей со списком деталей и в любом графическом редакторе (например, Paint или GIMP) порежьте эту картинку по вертикали на несколько штук.

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

Именно таким образом сделан полный список материалов для инструкции по сборке робота Валли.

Публикация проекта в LPub

Когда подготовленная инструкция вас полностью устраивает, можете сохранить её как PDF-файл. Делается это с помощью пункта меню «File -> Print to File». Кроме PDF вы можете экспортировать инструкцию как набор картинок png, jpeg или bmp с помощью группы пунктов меню «File -> Export As…». Картинки могут пригодиться, если вы хотите опубликовать инструкцию на своём сайте.

Итог работы с программами LDraw

И в заключении статьи хочется подвести краткий итог. Программы MLCad, LSynth и LPub вместе – это достаточно мощный инструмент для создания инструкций любой сложности, хотя и имеют ряд глюков и производят впечатление сыроватых продуктов. Например, программы LSynth и LPub не согласованы, и после работы программы LSynth приходится руками править файл проекта, чтобы провода в инструкции выглядели как надо. Но, пользуясь рекомендациями из этой статьи, вы сможете сделать красивую и подробную пошаговую инструкцию. Все вопросы по программам MLCad, LSynth и LPub оставляйте в комментариях. А всем кто очень сильно интересуется темой моделирования и создания инструкций, можно изучить и другие инструменты, такие как LeoCAD, LDCad, SR 3D Builder и официальную программу LEGO — LDD.

Инструкции по написанию: определение и примеры

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

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

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

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

Наблюдения и примеры

«Хорошие инструкции недвусмысленны, понятны, полны, последовательны и эффективны.»(Джон М. Пенроуз и др., Деловое общение для менеджеров: передовой подход , 5-е изд. Томсон, 2004 г.)

Легкая сторона инструкций: Справочник для недавно умерших

Juno: Хорошо, вы изучали руководство?
Адам: Ну, попробовали.
Juno: В главе о привидениях, посвященной промежуточному интерфейсу, сказано все. Вытащите их сами. Это твой дом. Дома с привидениями найти нелегко.
Барбара: Ну, мы не совсем понимаем.
Юнона: Я слышал. Сразу порвал твои лица. Очевидно, бесполезно отрывать голову перед людьми, если они вас не видят.
Адам: Тогда надо начинать проще?
Juno: Начни просто, делай то, что знаешь, используй свои таланты, тренируйся. Тебе следовало изучать эти уроки с первого дня. (Сильвия Сидни, Алек Болдуин и Джина Дэвис в Beetlejuice , 1988)

Основные характеристики

«Инструкции, как правило, следуют последовательной пошаговой схеме, независимо от того, описываете ли вы, как приготовить кофе или как собрать автомобильный двигатель.Вот основные особенности инструкций:

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

Последовательно упорядоченные шаги являются центральным элементом набора инструкций и обычно занимают большую часть места в документе.»
(Ричард Джонсон-Шихан, Техническая коммуникация сегодня . Пирсон, 2005 г.)

Контрольный список для написания инструкций

1. Используйте короткие предложения и короткие абзацы.
2. Расположите ваши точки в логическом порядке.
3. Сделайте ваши заявления конкретными.
4. Используйте повелительное настроение.
5. Ставьте самое важное в каждое предложение в начале.
6. Говорите одно в каждом предложении.
7. Тщательно подбирайте слова, по возможности избегая жаргона и технических терминов.
8. Приведите пример или аналогию, если вы думаете, что утверждение может озадачить читателя.
9. Проверьте готовый черновик на предмет логики изложения.
10. Не пропускайте шаги и не используйте ярлыки.

(Адаптировано из книги Writing With Precision Джефферсона Д. Бейтса. Penguin, 2000)

Полезные советы

«Инструкции могут быть как отдельными документами, так и частью другого документа. В любом случае наиболее распространенной ошибкой является то, что они слишком сложны для аудитории.Внимательно оцените технический уровень ваших читателей. Используйте пустое пространство, графику и другие элементы дизайна, чтобы сделать инструкции привлекательными. Самое главное, не забудьте включить ссылки «Осторожно», «Предупреждение» и «Опасность» с до — шаги, к которым они относятся ».
(Уильям Санборн Пфайффер, Карманное руководство по технической коммуникации , 4-е изд. Пирсон, 2007)

Инструкции по тестированию

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

Как написать руководство: рабочие инструкции

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

SwipeGuide серьезно относится к учебному дизайну. Философия и мыслительный процесс, лежащие в основе , почему инструкции и руководства пользователя так же важны, как и содержание в них. Слишком часто мы видим, что инструменты доставки [знаний] терпят неудачу просто из-за плохого дизайна.

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

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

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

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

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

Эксперты по учебному дизайну согласны с тем, что сочетание минимализма и структуры является ключом к:

• Производительность
• Понимание
• Обучение

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

В соответствии с этими принципами мы организовали нашу платформу обучения следующим образом:

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

• Направляющая
• Тема
• Инструкция
• Шаг

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

Гид.

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

Инструкция.

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

• Подготовьте машину
• Подготовить разделитель
• Безопасность прежде всего

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

Шаг.

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

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

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

• Для максимальной обучаемости и ясности задания следует описывать в активном настоящем времени (установить, нажать, щелкнуть, подписаться).
• Избегайте длинных многословных предложений, и мы рекомендуем разбивать задачи на две или более подзадач, когда пользователю необходимо выполнить несколько действий.
• Для обеспечения эффективности ваших инструкций рекомендуется не более 10–12 шагов.
• Если вы хотите, чтобы пользователи запомнили задачу, ограничьте информацию максимум 5-7 шагами.

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

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

Предоставьте более подробное описание с дополнительной информацией о том, как выполнить шаг.

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

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

Заключение.

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

Следуйте этим простым шагам при создании цифровых рабочих инструкций:

• Структурируйте свои рабочие инструкции в виде четкой, пошаговой иерархии инструкций
• (руководство — тема — инструкция — шаг).
• Используйте активный тон голоса при написании инструкций.
• Будьте краткими и по делу.
• Используйте наглядное изображение для иллюстрации шага.
• Разделите задачу на несколько разных подзадач.
• Разделите всю дополнительную информацию значками (предупреждения — подсказки — альтернативные маршруты — исправления ошибок).
• Поделитесь им с конечными пользователями в цифровом виде.

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

Как создать руководство пользователя

1. Определите своего пользователя и прицельтесь

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

2. Выберите подходящий стиль и формат

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

3. Обозначьте проблему, которую необходимо решить для ваших пользователей

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

4. Создайте соответствующий титульный лист

Кроме того, титульный лист является «лицом» вашего руководства пользователя — он не так важен в электронных руководствах пользователя, как в физических. Лучше создать титульный лист в минималистичном стиле и не тратить слишком много времени на креативный дизайн. Гораздо важнее предоставить всю необходимую информацию на титульном листе, чтобы каждый мог сказать, что это руководство по эксплуатации, его объем, аудитория, миссия, версия, дата публикации, ссылка, автор и т. Д.На самом деле, заголовок должен рассказывать все о вашем руководстве пользователя, в то время как все остальные текстовые метки должны просто содержать дополнительную информацию, указывающую на его применимость и актуальность для проблемы, которую пользователь пытается решить. Если вы не знаете, как назвать свой документ — руководство пользователя или руководство пользователя — прочтите об этом здесь.

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

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

6. Вставьте содержание

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

7. Выполните процедуру и представьте все действия как шаги

Этот шаг, вероятно, самый важный — он составит основную часть вашего руководства пользователя.Помимо точного и подробного описания каждого шага, вам нужно подумать о различных визуальных эффектах — в основном снимках экрана — чтобы проиллюстрировать все ваши действия в пошаговом руководстве пользователя, чтобы упростить понимание и воспроизведение шагов. Честно говоря, процедура довольно скучная, требует много времени и сил. К счастью, новейшие специализированные инструменты позволяют значительно сэкономить рабочее время. StepShot Guides, например, экономит до 90% времени, затрачиваемого на документирование процедуры, разве это не впечатляет? Вместо использования нескольких инструментов, таких как программное обеспечение для создания снимков экрана, редактор изображений и текстовый процессор, вы можете использовать StepShot Guides, объединяющие функции всех этих инструментов. В противном случае вам следует вручную скопировать, вставить и отредактировать каждый снимок экрана и текстовое поле в разные приложения. К счастью, представленное универсальное решение позволяет создать руководство из 20 шагов примерно за 15 минут вместо 150 минут, что в 10 раз быстрее.

8. Редактировать и улучшать

Какие бы инструменты вы ни решили использовать для создания руководства пользователя, вам необходимо отредактировать, улучшить и вычитать его после записи процедуры. На этом этапе у вас будет документ с текстом, включающим описание каждого шага и снимки экрана.Если вы выбрали традиционный способ o̶u̶t̶d̶a̶t̶e̶d̶ и используете несколько приложений, вам нужно сначала отредактировать каждый снимок экрана в редакторе изображений, а затем вставить его в документ. Затем вам нужно набрать вручную или скопировать текст. После этого вам нужно отформатировать документ, чтобы он выглядел красиво и легко читался.

Однако вы можете выбрать более простой подход и использовать направляющие StepShot. В этом случае вам просто нужно просмотреть руководство и улучшить уже автоматически аннотированные снимки экрана и записанные описания / названия шагов.Первый можно настроить изначально — использовать выделение положения курсора или выделение элемента под курсором кружком или прямоугольником. Итак, теперь вы можете либо оставить скриншоты как есть, либо использовать дополнительные стрелки, линии, фигуры, текстовые блоки, нумерацию последовательностей, размытие или обрезку изображения непосредственно в StepShot Guides. Что касается записанных описаний / заголовков шагов (вы можете выбрать, какие из них заранее), вы также можете отредактировать их, чтобы исправить любые ошибки или добавить другой текст. Воспользуйтесь технологией OCR, чтобы распознать текст на изображении и вставить его в нужное место.И не беспокойтесь о форматировании — оно будет автоматически применено ко всем вашим документам с помощью готового шаблона инструкции по вашему выбору. Благодаря функциям на базе искусственного интеллекта процесс редактирования и улучшения здесь требует гораздо меньше времени, чем при традиционном подходе.

9. Разработайте шаблон инструкции по эксплуатации

Подумайте о макете вашего руководства пользователя — он важнее, чем вы думаете, поскольку макет похож на интерфейс: если он не удобен для пользователя, пользователю будет трудно его воспринимать, перемещаться и следовать.Подумайте об оглавлении, форматировании заголовков, шрифте, цветах, полях, графических элементах, межстрочном интервале и т. Д. Даже если вы работаете в обычном текстовом редакторе, лучше сохранить шаблон инструкции по эксплуатации, а не просто форматировать документ — вам может понадобиться тот же шаблон инструкции позже. Если вы работаете в StepShot Guides — как обычно, процедура намного проще. Если вам нужно руководство пользователя в формате PDF, импортируйте собственный шаблон руководства или отредактируйте один из доступных — фактически, отредактируйте только титульную страницу, оглавление и страницу с шагом — остальная часть вашего документа будет отформатирована автоматически. Кроме того, вы можете воспользоваться заранее заданными повторяющимися текстовыми метками — набором переменных, таких как название компании, адрес или контакты, дата, версия документа или все, что вам нужно. Если вы предпочитаете формат Word, просто загрузите существующий шаблон руководства по эксплуатации, отформатируйте те же три страницы так, как вам нравится, и импортируйте его в StepShot Guides. Тем не менее, вы всегда можете использовать один из доступных шаблонов и просто пропустить этап создания шаблона инструкции по эксплуатации.

10. Экспорт и обмен

Последний шаг — экспорт и отправка вашего руководства по эксплуатации.Если он был создан с помощью текстового редактора, как правило, вы можете экспортировать его в некоторые текстовые форматы или PDF. Более того, средний текстовый процессор не предлагает широкий выбор вариантов совместного использования — даже в расширенных инструментах это обычно просто электронная почта (конечно), а иногда и веб-страница. Хорошей новостью является то, что в StepShot Guides есть МНОГО вариантов экспорта и обмена. Таким образом, вы можете экспортировать свое руководство пользователя в:

• Слово

• PDF

• HTML (вы можете вставить его прямо на свой сайт, в справочный центр или в базу знаний)

• Видео (да, вы можете создать даже видеоурок, и это не сложнее обычного документа!)

• изображений (сохраните все аннотированные снимки экрана в папку с изображениями)

• PowerPoint (создать презентацию)

Что касается совместного использования, здесь у вас также есть несколько вариантов:

• Confluence

• WordPress

• StepShot Cloud (сохраняйте и делитесь своими руководствами с пользователями или товарищами по команде, создайте справочный центр на своем субдомене или встроите его на свой веб-сайт)

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

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

Направляющие StepShot

StepShot Guides — это универсальный инструмент специального назначения для тех, кто узнает, как создавать практические руководства или другую пользовательскую документацию. Я уже рассказывал вам о некоторых функциях этого программного обеспечения, которые могут быть полезны при написании руководства пользователя, а теперь я хотел бы подробнее рассказать о процессе создания руководства в StepShot Guides.Сначала вы запускаете этот инструмент и нажимаете «Capture Process», а затем просто выполняете процедуру, о которой хотите написать руководство — приложение фиксирует все ваши шаги. После завершения процедуры ваше руководство откроется в окне приложения и будет выглядеть как набор снимков экрана (снятых при каждом щелчке мыши или других щелчках, выбранных заранее), а также заголовки и описания шагов, многие из которых уже автоматически записываются кейлоггером. Теперь вам нужно добавить новый и при необходимости отредактировать существующий текст — воспользуйтесь функцией «Захватить текст», которая распознает любой текст на вашем изображении и скопирует его в буфер обмена.Затем выберите формат для экспорта и при желании внесите в шаблон руководства по эксплуатации дальнейшие редакции. Определите переменные, которые будут отображать повторяющиеся данные в ваших руководствах. Если вы выберете экспорт в StepShot Cloud, вы сможете продолжить работу с руководством в частном или общедоступном режиме. Воспользуйтесь многочисленными опциями совместного использования и отправьте или вставьте свои руководства пользователя, когда это необходимо.

Преимущества: экономит до 90% вашего времени, автоматизированные процессы искусственного интеллекта, встроенный редактор изображений и настраиваемые шаблоны, различные варианты экспорта и обмена.

Недостатки: StepShot Cloud пока только бета-версия — все еще в разработке.

См. Короткую видеодемонстрацию руководств StepShot, созданных с помощью самих направляющих StepShot!

Microsoft Office Word

Microsoft Office Word , вероятно, является наиболее широко используемым текстовым процессором. Соответственно, люди используют MO Word как традиционный инструмент для создания любых текстов и документов. Неудивительно, что многие из нас начинают использовать это программное обеспечение, когда думают о том, как написать руководство по эксплуатации.По сути, процедура создания руководства пользователя выглядит следующим образом: создать титульную страницу, написать предисловие, описать каждый шаг, вставить уже отредактированные скриншоты, добавить другой необходимый текст и отформатировать руководство пользователя. Это программное обеспечение управляет шаблонами и может сохранять документ в виде файла PDF, Open XML, XPS, RTF, OpenDocument или веб-страницы. Он также обменивается файлами Word по электронной почте, публикует их в блогах или представляет в Интернете.

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

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

Ножницы для Windows

Windows Snipping Tool (или инструмент с той же функциональностью для Mac OS) часто используется для создания снимков экрана. Вы можете настроить область захвата так, чтобы она захватывала либо весь экран, либо определенную область на нем. Есть несколько встроенных инструментов редактирования, а именно таймер захвата, ручка вольного стиля, маркер и ластик. Очевидно, почему это программное обеспечение используется для создания снимков экрана: это стандартный инструмент Windows 7 +, который интуитивно прост в использовании. Но представьте себе, что вам нужно сделать 100 снимков экрана для 100-шагового руководства пользователя, что тогда? Имеет ли этот Snipping Tool достаточную функциональность для улучшения снимков экрана? Даже если да, вам придется делать каждый снимок экрана вручную, редактировать, сохранять и вставлять в документ. Более того, во встроенном редакторе изображений отсутствуют функции, поэтому пользователям приходится использовать другое программное обеспечение для редактирования и улучшения снимков экрана.

Преимущества: простой и легкий в использовании захват экрана, инструмент по умолчанию в Windows.

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

Adobe Photoshop

Adobe Photoshop — это продвинутый редактор изображений, используемый профессионалами для создания и редактирования изображений, включая фотографии. Очевидно, что ни один графический редактор не может конкурировать с этой программой по ряду функций — она ​​действительно может все.Что касается скриншотов, которые обычно используются в руководствах пользователя, вы можете обрезать их, добавлять выделение, добавлять различные стрелки, формы, числа, текст и так далее. Если вы уверены в своих сильных навыках работы с Adobe Photoshop, вы можете создать целое руководство прямо в этом инструменте — создать несколько листов формата A4, ввести вручную или скопировать текст, сделать скриншоты с помощью другого инструмента и вставить их сюда, аннотировать их, и отредактируйте все руководство. Это требует профессиональных навыков, большого количества времени, усилий и терпения.Такое руководство можно преобразовать в PDF или просто сохранить для дальнейшего редактирования.

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

Недостатки: требует профессиональных навыков пользователя, не может сделать снимок экрана, отсутствие параметров экспорта и обмена.

Снагит

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

Достоинства: широкие возможности захвата экрана, редактор изображений.

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

Google Диск и Google Документы

Google Диск и Документы Google представляют собой другую сторону — их нельзя использовать для создания или редактирования снимков экрана и изображений, но они полезны при написании, хранении и совместном использовании руководств пользователя. Если говорить о Google Docs, они имеют почти те же функции, что и Microsoft Office Word, но онлайн.Это удобная веб-платформа для создания документов и обмена ими, интеллектуального редактирования и совместной работы в команде. Он позволяет вставлять изображения и использовать шаблоны для более быстрого форматирования набора документов. В свою очередь, Google Drive предлагает хранить и делиться файлами любых форматов. Комбинация этих инструментов предоставляет пользователю множество возможностей, однако они не могут снимать экран или автоматически записывать описания шагов.

Достоинства: практически безлимитный обмен, простота использования.

Недостатки: не может захватывать экран, требует ручного набора и вставки изображений.

DropBox и DropBox Paper

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

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

Недостатки: не относится к захвату экрана и созданию руководств пользователя в различных форматах.

Microsoft Excel или Google Таблицы

Microsoft Excel или Google Таблицы — интересно, почему они появляются в статье о том, как написать руководство? Я скажу вам, почему — они нужны тем, кто использует традиционные методы создания руководств пользователя — инструмент для создания снимков экрана, редактор изображений и текстовый редактор.Как вы можете видеть в полном руководстве о том, как сделать руководство по эксплуатации выше, важным шагом в этом процессе является ссылка на руководство пользователя с другой пользовательской документацией. Но как вы это сделаете, если у вас просто есть папка с документами, в лучшем случае, в облаке? У вас должна быть таблица с категоризованными списками руководств пользователя и других соответствующих документов с соответствующими ссылками, чтобы упростить поиск всей необходимой информации, просто просматривая таблицу. Кроме того, вы можете использовать определенные теги и метки, доступные в специальных инструментах и ​​платформах, таких как StepShot Cloud.

Достоинства: демонстрационных инструментов для управления пользовательской документацией.

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

Чтобы вам было проще выбрать лучший вариант в вашем случае, мы создали таблицу, в которой сравниваются функции всех этих инструментов. Посмотрите, какие инструменты обладают необходимыми вам функциями. Например, если вас не интересуют параметры экспорта и обмена, выберите текстовый процессор, например Microsoft Office Word и Windows Snipping Tool или Snagit.Тем не менее, как вы можете видеть, лидером здесь является StepShot Guides, поскольку он имеет все необходимые функции, необходимые для создания инструкции по эксплуатации.

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