Владимир Юсупов - Как написать понятную инструкцию. Опыт инженера
Название: | Как написать понятную инструкцию. Опыт инженера | |
Автор: | Владимир Юсупов | |
Жанр: | Околокомпьютерная литература, Руководства и инструкции, Педагогика | |
Изадано в серии: | неизвестно | |
Издательство: | SelfPub | |
Год издания: | 2023 | |
ISBN: | неизвестно | |
Отзывы: | Комментировать | |
Рейтинг: | ||
Поделись книгой с друзьями! Помощь сайту: донат на оплату сервера |
Краткое содержание книги "Как написать понятную инструкцию. Опыт инженера"
Инженеры разучились писать инструкции. Такой вывод сделан автором на основе изучения технической документации в рамках выполнения работ по импортозамещению зарубежного программного обеспечения и разработанных на их основе информационных систем. Автор — инженер с 15-летним опытом работы в сфере информационных технологий — делает попытку улучшить сложившуюся ситуацию. В книге представлены как методологическая составляющая написания понятной инструкции, так и рекомендации по ее оформлению. Книга адресована инженерам, а также студентам инженерных специальностей, и может быть использована в качестве памятки при написании инструкций.
К этой книге применимы такие ключевые слова (теги) как: Самиздат,руководство,профессиональные коммуникации,пошаговые инструкции,коммуникация,инженерно-техническая деятельность
Читаем онлайн "Как написать понятную инструкцию. Опыт инженера". [Страница - 5]
Первую фазу вычитки выполните самостоятельно (причем, как минимум, трижды и при этом вслух), а для второй фазы найдите наблюдателя.
Наблюдателем может стать ваш коллега-инженер или (возможно, в вашей компании таковой имеется) коллега-техписатель. В общем, важно здесь то, чтобы кто-то помимо вас самих прочитал инструкцию и выполнил проверку на логику и грамматику.
Рисунок 4. Двухфакторная вычитка инструкции
Часть 2. Оформление
Зачем нужно оформление?
Как уже указывалось ранее, оформление является неотъемлемой частью разработки понятной инструкции. Вы можете подготовить прекрасный материал, но плохое оформление сведет все ваши старания и усилия на нет.Речь здесь совсем не про какой-то креативный дизайн, а про улучшение визуального восприятия информации вашей инструкции.
Для этого просто применяйте следующие четыре элемента структуры документа:
— заголовки,
— списки,
— таблицы,
— графический материал.
Заголовки
Основное назначение заголовков — обеспечение структуры документа. Заголовки позволяют читателям инструкции выборочно просматривать и знакомиться только с той информацией, которая на текущий момент им интересна.Каждый раздел документа начинайте с заголовка.
Если у разделов есть подразделы, то обязательно их так же озаглавливайте. При этом убедитесь, что уровни заголовков визуально различаются.
Сравните два варианта, представленные в таблице 1.
Таблица 1. Уровни текстовых заголовков
Вариант А, который является неправильным, вводит читателя в заблуждение. Складывается представление, что заголовки имеют один и тот же уровень логического изложения материала. Но на самом деле, второй и третий заголовки начинают подразделы предыдущих разделов.
Вариант Б является правильным. Здесь сразу видна разница уровней заголовков. Размер шрифта заголовка подраздела должен быть меньше шрифта заголовка раздела.
Это правило также касается и нумерованных заголовков.
Посмотрите пример в таблице 2.
Таблица 2. Уровни нумерованных заголовков
Списки
Списки являются полезным и эффективным инструментом организации материала инструкции, выделения важных идей, упрощения длинных предложений или абзацев. Списки улучшают восприятие информации.
При использовании списков для подготовки понятной инструкции обратите внимание, как минимум, на следующие:
— тип,
— длина,
— свободное пространство.
Типы списков
При имеющихся плюсах списков неправильное их оформление может оказать противоположное (негативное) влияние на восприятие информации.
Чтобы избежать этого, уясните какие типы списков существуют и в каких случаях их следует применять.
Наиболее распространенные типы списков:
— маркированный,
— нумерованный.
Маркированные списки применяйте в тех случаях, когда последовательность перечисления не важна. Пункты маркированного списка оформляются одинаковыми маркерами.
Нумерованные списки применяйте в обратных случаях, когда последовательность перечисления имеет значение. Пункты нумерованного списка оформляются уникальными порядковыми номерами или буквами (как заглавными, так и строчными).
Длина списка
Длина списка — это число элементов этого списка.Каждый список должен содержать минимум два элемента, иначе это уже не список. Что же касается --">
Книги схожие с «Как написать понятную инструкцию. Опыт инженера» по жанру, серии, автору или названию:
Михаил Васильевич Шохирев - Язык программирования Perl Жанр: Околокомпьютерная литература Год издания: 2006 |
А Ш Левин - Интернет для людей старшего возраста Жанр: Интернет Год издания: 2014 |
Мирзакарим Санакулович Норбеков, Геннадий Волков - Антикризисный опыт дурака Жанр: Психология Год издания: 2015 |
Вячеслав Олегович Рузов - Мировой опыт разрешения семейных проблем Жанр: Психология Год издания: 2005 |