You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 235 Next »

Если вы зашли на эту статью, значит, вы автор инструкций или станете им завтра! 

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

Здесь мы собрали всё, что знаем, чтобы сделать инструкции максимально полезными и понятными (thumbs up)



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

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




Подготовка

Чтобы быстро начать и подготовить основу для инструкции, воспользуйтесь простой формулой «Что–Зачем–Как» и ответьте на три вопроса:

  1. Что я хочу рассказать? (Заголовок вашей инструкции)
  2. Зачем это нужно читателю? (Цель инструкции)
  3. Как это можно сделать? (Какие шаги нужно выполнить)

(lightbulb) У вас появится эскиз инструкции, который можно дорабатывать и детализировать.

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

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

(lightbulb) Укажите цель в самой инструкции перед основным содержанием, это поможет установить правильную настройку читателя на работу с информацией. 

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

Существуют виды планов: вопросный, назывной, опорный, тезисный, цитатный. Для подготовки инструкции чаще всего используют назывной или тезисный план. 

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

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

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

(lightbulb) Правильная структура помогает достигнуть поставленной цели.  

Если вы готовите несколько типовых инструкций, разработайте шаблон.

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

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

Пример шаблона


  • Следуйте структуре.
  • Сопровождайте текст графикой (схемы, иконки, иллюстрации), чтобы улучшить понимание. Визуализируйте данные или идеи, делая их более доступными и понятными. К тексту по работе с ПО добавляйте скриншоты. А к скриншотам, в свою очередь, — сопроводительный текст. Выделяйте на скриншотах кнопки и зоны, о которых идёт речь (любые элементы: стрелки, цветные рамки, выноски). Если вам нужно объяснить порядок действий, лучше использовать гифки или видео.  Это эффективный приём, когда описание алгоритма слишком громоздкое или сложное. 
  • Предоставьте алгоритм (последовательность действий, которая ведет к желаемому результату). Вы можете дать алгоритм в начале текста, а затем подробно разъяснить каждый пункт. Или выделить ключевые слова в списке таким образом, чтобы алгоритм легко прочитывался.
  • Не пропускайте шаги, которые кажутся простыми. Если читателю знаком этот шаг, то он пропустит его сам. В то же время не стоит описывать очевидные вещи. Чтобы не пропустить важное и не погрязнуть в излишней детализации, проверяйте текст на фокус-группе или, как минимум, просите вычитать кого-то из коллег.
  • Излагайте мысли последовательно и точно. Ни в коем случае не допускайте ситуаций, когда описание можно не понять или понять двояко (помните о своей аудитории и уровне её подготовки).
  • Избегайте описания ситуаций из личного опыта, так как это отвлекает внимание читателей и увеличивает время чтения.
  • Используйте информационный стиль — полезный, простой, понятный. Формулируйте мысли коротко и просто (в предложении 8-10 слов). Фокус должен быть на решении задачи (проблемы) или действии пользователя.  

  • Делайте опору на активный глагол. По возможности не используйте пассивный залог и отглагольные существительные.  

ПлохоХорошо
Курс Revit базовый должен быть пройден вамиПройдите обучение по курсу Revit базового уровня
  • Пишите и общайтесь гендерно-нейтрально.

ПлохоХорошо
Я хотел(а) бы рассказать, как можно увеличить продажи с помощью настроекРазберём, как увеличить продажи с помощью новых настроек
  • Всегда сохраняйте вежливый и нейтральный тон. В тексте может использоваться обращение к пользователю на «ты», но старайтесь всю коммуникацию делать обезличенной.

  • Будьте осторожны с юмором: он не должен быть слишком ярким или задевать чьи-то чувства.

«Стандартной страницей» текста (формат А4) обычно считается 1800 печатных знаков с пробелами. Внимательное чтение текста такого объёма займёт в среднем 9-10 минут. Статистика также показывает, что человек способен воспринимать однообразную информацию не дольше 20 минут.

(lightbulb) Если текст вашей инструкции большого объёма, то вы поможете читателю, оформив оглавление. Или разбейте большую инструкцию на две. 

Оформление

Здесь собраны методические и технические правила оформления текста. 

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

Например:

  • Дисциплина → Архитектурный BIM → Коммерция → Подразделы → Создать новую страницу
  • Сервисы → Учебный центр BIM → Методика → Создать новую страницу

check mark Нажмите значок «Создать» в правом верхнем углу.

check mark Выберите свой шаблон или используйте пустую страницу.


check mark Введите заголовок страницы. 

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

ПлохоХорошо

Проемы и отверстия в стенах.

Стены. Проемы и отверстия

Стены: проемы и отверстия


check mark Используйте общепринятые термины и аббревиатуры. 

ПлохоХорошо

Оформление ДМ

Подбетонка

Оформление демонстрационных материалов

Бетонная подготовка


check mark Структурируйте текст, придерживайтесь подхода «От общего к частному».

ПлохоХорошо

Общее описание технологии армирования нетиповых этажей

Армирование. Общее описание. Нетиповые этажи


check mark Не дублируйте название предыдущего уровня, если логическая цепочка не обрывается.

ПлохоХорошо

Инструменты PIKTools

Общие инструменты

Общая Печать листов

PIKTools

Общие инструменты

Печать листов


check mark
Добавьте цели и укажите, кто целевая аудитория (если потребуется). Это поможет читателю сориентироваться, о чём текст.  Здесь можно также указать
 связь с другими документами, если этого сложно добиться другими способами (классификация уровней, метки).



check mark
Вставьте оглавление, если в тексте больше двух абзацев.

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

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

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



check mark Основной текст выполняйте стилем «Абзац». Используйте преимущественно простые конструкции предложений.

Для деления текста используйте систему заголовков. 

check mark Форматируйте тест при помощи встроенных инструментов.

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

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

  • Пример
  • Пример
  • Пример

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

  1. Действие 
  2. Действие
  3. Действие


check mark Разбивайте текст для улучшения его восприятия. Следуйте правилу: один абзац должен содержать 4-5 предложений. Или воспользуйтесь инструментом «Разметка страницы». 

 check mark Используйте также разделительную линию, чтобы зонировать текст. 



check mark Изучите макросы из основного списка и блока «Другие макросы». Это поможет вам автоматизировать задачи по организации контента. Вы сможете создавать структурированный и удобный для восприятия текст.

 check mark Выделяйте текст. 

Чтобы выделить текст (особенно, если в текстовом блоке больше 3-4 слов), не рекомендуется использовать капслок, красный цвет и курсив: ЧТО БЫ НИ СЛУЧИЛОСЬ, НИ В КОЕМ СЛУЧАЕ НЕ НАЖИМАЙ ЭТУ КЛАВИШУ! 

Обычно текст, оформленный подобным образом, читатели игнорируют или просматривают бегло. Текст, набранный основным шрифтом, прочтут с большей вероятностью. Для выделения блока лучше использовать эмодзи или символы: или специальные блоки. Можно также использовать слова: Внимание! Совет и др.

Введите систему маркировки для типовых элементов и на протяжении всего текста придерживайтесь правил этой маркировки. 

Например:

  • полужирный шрифт — для описания названий элементов интерфейса и кнопок

  • прописная буква и кавычки (ёлочки) — для описания команд, вводимых пользователем

  • курсивный шрифт — для терминов или привлечения внимания к определенным словам (предложения, набранные курсовом плохо читаются)

  • рамка — для оформления фрагментов кода

  • маркеры и иконки — для типовых блоков: путь к файлу, порядок действий, важная информация

Кавычки предназначены, чтобы выделить слова внутри текста, а также исключить искажение смысла. Если шрифт выделяемого слова отличается от основного текста (аббревиатура, название на латинице), то кавычки не нужны. Например: компания ПИК ср. компания «Ромашка» или клавиша Tab ср. клавиша «Удалить»

Верхние кавычки, или лапки  — “” — легче набрать на клавиатуре, но их используют в английском языке. В русском языке правила всё же требуют использования кавычек, известных как «ёлочки». Лапки нам пригодятся, когда нужно что-то закавычить слово или словосочетание внутри уже закавыченного (это редкий случай).

Сочетание клавиш в Windows для ёлочек: 

« —  alt + 0171
» —  alt + 0187


Чтобы выделить текст в виде блока, используйте макрос Info: 






check markОформляйте содержательные ссылки на другие ресурсы

check markУказывайте под основным текстом (сноской) использование информации из [название источника], если заимствуете материал из других источников больше 20%


check mark Сохраните статью после редактирования, для этого нажмите «Обновить». Если вы хотите, чтобы все, кто подписан на статью узнали об изменениях, установите флажок «Сообщить наблюдателям».


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

Перетащите объект в поле страницы в режиме редактирования. 




















Воспользуйтесь инструментом меню «Вставить изображение».

Отроется окно. 

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



При создании новых разделов и  страниц обязательно следует проставлять метки их принадлежности:

  • к дисциплине (разделу проектирования): АР, КР, ЭОМ и т.д.
  • к инструментам и ПО: Revit, Civil 3D, Family Manager, BIM Inspector, PIKTools и т.д. 
  • к сервису: BIM-поддержка , BIM-координация, Фабрика семейств, Учебный центр. 

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

Добавить метку к тексту можно двумя способами.

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

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

В диалоговом окне введите названия необходимых меток и нажмите кнопку «Добавить».  Если метка с таким именем уже существует, она появится в меню автоподстановки. Новое имя добавится в каталог.

Общие правила наименования:

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

инструкции

но! требование

bim координатор

Civil 3D

инструкция

требования

bim-координатор

civil3d

 Изучите каталог меток, прежде чем создавать новую метку. Возможно, что-то похожее уже существует. 

Общие правила размещения  меток:

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

  • Добавляйте метки к странице по принципу «от общего к частному»
Обязательные →Категории, пространства, раздела →Дополнительные →Основные (суть темы) 
bim
проектный_блок
кадры
маркетинг
и т.д.

ар
кр
эом
revit
civil3d
fm
bim-inspector
piktools 
bim-поддержка 
bim-координация
фс 
уц
и т.д.

коммерция
реновация
рабочая_документация
спецификация
задача
обучение
новости
р22 (шифр проекта)
и т.д.

оси
координаты
помещение
вор
реестр
ошибка
ипр
отпуск
и т.д.

Проверка


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

  • Сложные конструкции — разбиваем на несколько предложений 
  • Страдательный (пассивный) залог — меняем конструкции предложений
  • Отглагольные существительные — меняем на глаголы 
  • Канцеляризмы — удаляем
  • Вводные слова — проверяем на уместность
  • Риторические вопросы — проверяем на уместность
  • «Воду» — отжимаем
  • Сленг — удаляем (это правило для источника информации, который попадает в публичное пользование, можно оставлять только профессиональные термины)
  • Главред — инструмент для автоматической проверки текста обеспечивает двойной контроль и подсвечивает проблемные зоны. Стремимся к оценке 9 на вкладке «Чистота» и «Читаемость»
  • Яндекс.Степллер помогает находить и исправлять орфографические ошибки в русском, украинском или английском тексте. Языковые модели Спеллера включают сотни миллионов слов и словосочетаний 
  • LanguageTool ищет грамматические, стилистические и пунктуационные ошибки 


Чтобы убедиться в качестве разработанной инструкций, проверьте её по критериям: 

  1. Ясность: текст инструкции понятен и прост для восприятия
  2. Краткость: в инструкции нет лишней информации, передана только суть
  3. Последовательность: шаги логически выстроены
  4. Детализация: каждый шаг описан достаточно подробно
  5. Визуализация: текст сопровождается графикой, иллюстрациями и скриншотами
  6. Надёжность: есть подтверждение, что инструкция работает, она протестирована
  7. Эффективность: прочтение инструкции занимает не больше времени, чем это необходимо

Примеры инструкций

  • No labels