Владимир Юсупов - Как написать понятную инструкцию. Опыт инженера
Название: | Как написать понятную инструкцию. Опыт инженера | |
Автор: | Владимир Юсупов | |
Жанр: | Околокомпьютерная литература, Руководства и инструкции, Педагогика | |
Изадано в серии: | неизвестно | |
Издательство: | SelfPub | |
Год издания: | 2023 | |
ISBN: | неизвестно | |
Отзывы: | Комментировать | |
Рейтинг: | ||
Поделись книгой с друзьями! Помощь сайту: донат на оплату сервера |
Краткое содержание книги "Как написать понятную инструкцию. Опыт инженера"
Инженеры разучились писать инструкции. Такой вывод сделан автором на основе изучения технической документации в рамках выполнения работ по импортозамещению зарубежного программного обеспечения и разработанных на их основе информационных систем. Автор — инженер с 15-летним опытом работы в сфере информационных технологий — делает попытку улучшить сложившуюся ситуацию. В книге представлены как методологическая составляющая написания понятной инструкции, так и рекомендации по ее оформлению. Книга адресована инженерам, а также студентам инженерных специальностей, и может быть использована в качестве памятки при написании инструкций.
К этой книге применимы такие ключевые слова (теги) как: Самиздат,руководство,профессиональные коммуникации,пошаговые инструкции,коммуникация,инженерно-техническая деятельность
Читаем онлайн "Как написать понятную инструкцию. Опыт инженера". [Страница - 7]
Все графические изображения в документации считаются рисунками.
Нумерация графического материала
Правила нумерации графических изображений в инструкции аналогичны принципам нумерации таблиц. Отличие только в том, что вместо слова «Таблица» используется слово «Рисунок» (например, рисунок 1.)
Наименование графического материала
Здесь также по аналогии с таблицами. Единственное отличие в размещении наименования. Текст наименования рисунка располагайте непосредственно под графическим изображением (рисунком).
Часть 3. Памятка
Соблюдайте принципы создания инструкцийОсознайте главную задачу (проблему), стоящую перед пользователем. Затем последовательно и понятными пользователю словами опишите его действия для решения данной задачи.
Помните о проклятии знаний
Во время написания инструкции всегда ставьте себя на место вашего пользователя. Помните, что он имеет меньший уровень знаний о продукте, чем вы.
Описывайте действия пользователя в повелительном наклонении
Побуждайте пользователя выполнить нужное действие. Обращайтесь к нему вежливо. Используйте глаголы в форме множественного числа повелительного наклонения.
Аккуратно оформляйте инструкцию
Плохое оформление может свести на нет всю полезность и понятность материала. Для улучшения визуального восприятия информации в инструкции используйте заголовки, списки, таблицы, графический материал.
Вычитывайте документ
После окончания работы над инструкцией обязательно прочтите написанное вслух. Пройдитесь по всем шагам самостоятельно. Это простое действие позволяет выявить и устранить логические и грамматические ошибки.
Вычитывайте документ!
После первой вычитки обязательно прочтите написанное вслух еще раз. Повторно пройдитесь по всем шагам самостоятельно. Это очень простое действие позволяет дополнительно выявить и устранить логические и грамматические ошибки.
Вычитывайте документ!!
После второй вычитки обязательно прочтите написанное вслух еще раз. В третий раз пройдитесь по всем шагам самостоятельно. Это совсем простое действие позволяет дополнительно выявить и устранить логические и грамматические ошибки.
Ответьте на вопросы самоконтроля
После вычитки инструкции ответьте себе на три вопроса:
— Что я пытался сказать?
— Сказал ли я то, о чем собирался?
— Понятно ли это тому, кто впервые слышит об этом?
Если хотя бы на один из перечисленных вопросов вызывает у вас трудности с ответом, вернитесь к началу работы над инструкцией.
Покажите товарищу
После ответа на вопросы самоконтроля попросите коллегу протестировать инструкцию, получите обратную связь и при необходимости доработайте документ.
Послесловие
Дорогой коллега, представленный в данной небольшой книге материал не является исчерпывающим руководством. Многое зависит от конкретных условий, в которых вы находитесь, и требований, которые предъявляются к вашему документу. Но приведенные принципы и рекомендации помогут вам в большинстве случаев подготовить понятную вашим пользователям инструкцию.Если в процессе прочтения у вас возникли вопросы или замечания по затронутой теме, то свяжитесь со мной по указанному в подписи адресу электронной почты. Я всегда открыт к диалогу, а также рад новым знакомствам.
Благодарю вас, что уделили внимание моей небольшой работе и желаю вам успеха в написании понятных инструкций!
С уважением,
Владимир Юсупов
Неравнодушный к документации инженер
vladimir@techwritex.ru
Примечания
1
ГОСТ Р 2.601-2019 Единая система конструкторской документации. Эксплуатационные документы.(обратно)
2
Бабайцева В.В. Русский язык. Теория. 5 — 11 классы: Учебник для школ и классов с углубл. рус. яз. — 3-е изд., испр. — М.: Дрофа, 2000. — 432 с. (обратно)--">
Книги схожие с «Как написать понятную инструкцию. Опыт инженера» по жанру, серии, автору или названию:
TemplateMonster - Как быстро создать интернет-магазин Жанр: Интернет Год издания: 2018 |
Виталий Дмитриевич Бутерин, Виталик Бутерин - Больше денег: что такое Ethereum и как блокчейн меняет мир Жанр: Деловая литература: прочее Год издания: 2023 Серия: Individuum |