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