Автор Тема: Как написать инструкцию  (Прочитано 5398 раз)

0 Пользователей и 1 Гость просматривают эту тему.

Оффлайн Пользователь.

  • Местный
  • *****
  • Автор темы
  • Сообщений: 4500
Как написать инструкцию
« : Февраль 16, 2015, 16:07:28 »
Когда пишу какую-нибудь инструкцию, тратится много времени на обдумывание содержания, стилистики, оформления.

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


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

Шаблон:
Титульный лист (тема, автор, год)
Содержание (список заголовков)
заголовок1
текст1
заголовок2
текст2
...
В конце источники, литература.


Оформление:
Заголовок: по центру, крупным шрифтом, жирным начертанием, черным или другим контрастным цветом по отношению к фону.
Текст: абзацы, знаки препинания, выравнивание слева, поля (1,5-2см.)
Изображения: выравнивание по горизонтали по центру, надпись под изображением - тоже по центру.
Ссылки: должны отображаться в виде короткого выделенного цветом слова, а полный адрес должен быть скрыт.

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


Инструменты:
Составлять инструкцию удобнее в LibreOffice Writer, затем экспортировать в PDF с встраиванием шрифтов и выгрузкой закладок.
Встраивание шрифтов необходимо для корректного отображения текста на любом компьютере.
Выгрузка закладок необходима для создания содержания в боковой панели.
« Последнее редактирование: Февраль 21, 2015, 10:36:37 от Universe »

Оффлайн Пользователь.

  • Местный
  • *****
  • Автор темы
  • Сообщений: 4500
Re: Как написать инструкцию...
« Ответ #1 : Февраль 20, 2015, 17:52:32 »
Оказалось содержание в боковой панели не удобно.
Оно не распечатывается, не отображается в веб браузере.
Посмотреть его можно только в спец программах, да и то боковую панель придется растянуть на пол экрана, чтобы видеть все слова.


Так что уберу информацию о таком содержании, оставлю только после титульного листа.

Содержание нужно в основном для просмотра заголовков, чтобы понять о чем написано, а чтение уже идет постранично.
« Последнее редактирование: Февраль 20, 2015, 18:10:12 от Пользователь. »

Оффлайн runtik

  • Местный
  • *****
  • Сообщений: 578
  • Проблема - когда нет проблем
Re: Как написать инструкцию...
« Ответ #2 : Февраль 20, 2015, 18:36:13 »
Можно, конечно, сделать гиперссылки в документе, но смотрится не очень... ???

Runtu XFCE x64: EeePC 1015BX - 16.04.5; DNS Porto - 14.04.5.
-->

Оффлайн Пользователь.

  • Местный
  • *****
  • Автор темы
  • Сообщений: 4500
Re: Как написать инструкцию...
« Ответ #3 : Февраль 20, 2015, 19:14:59 »
Содержание делается так.

Выделяем заголовок, в стилях выбираем заглавие или заголовок такого-то уровня.
Когда все заголовки так помечены, ставим курсор куда надо сформировать содержание.
Выбираем в меню Вставить - Оглавление и указатели - Оглавление и указатели.
Напротив пункта Дополнительные стили ставим галку, напротив него в квадратике выбираем стили которые использовались кроме заголовков 1,2,3,4,5,6,7,8,9,10
Мне например нужно там выбрать заглавие, и стрелкой переместить под цифру 1 (как заголовок первого уровня).
Нажимаем Да и содержание готово.

Оффлайн Пользователь.

  • Местный
  • *****
  • Автор темы
  • Сообщений: 4500
Re: Как написать инструкцию...
« Ответ #4 : Февраль 20, 2015, 19:28:53 »
При экспорте в PDF можно убрать галку с пункта выгрузки закладок, это отменит создание содержания в боковой панели.

--------

В Firefox оказалось тоже можно смотреть содержание в боковой панели, а боковую панель можно выдвинуть - выбрать - задвинуть.
Так что содержание пригодится и под титульным листом для распечатки на бумаге и в боковой панели для быстрого доступа.
« Последнее редактирование: Февраль 20, 2015, 20:14:32 от Пользователь. »

Оффлайн gvitaly

  • Местный
  • *****
  • Сообщений: 516
Re: Как написать инструкцию...
« Ответ #5 : Февраль 20, 2015, 20:40:39 »
Можно, конечно, сделать гиперссылки в документе, но смотрится не очень... ???


Гиперссылки можно сделать любым шрифтом, любым цветом, и без подчеркивания. Такие ссылки хорошо делать внутри самого документа, типа:
Цитировать
менеджер пакетов Synaptic, о котором подробно в разделе Установка/удаление программ
Так удобно перемещаться по документу.
Но оглавление удобно делать автоматически (вроде об этом написал Пользователь.), если к заголовкам применен нужный стиль (Заголовок 1, Заголовок 2...).
p.s. я как-то содержание вообще в виде картинок делал, и они работали как гиперссылки внутри документа, переходили на соответствующий заголовок:


Оффлайн Пользователь.

  • Местный
  • *****
  • Автор темы
  • Сообщений: 4500
Re: Как написать инструкцию...
« Ответ #6 : Февраль 20, 2015, 21:39:35 »
Поизучал еще вопрос формирования содержания.


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

Оффлайн gvitaly

  • Местный
  • *****
  • Сообщений: 516
Re: Как написать инструкцию
« Ответ #7 : Февраль 21, 2015, 19:52:21 »
Позвольте высказать свое мнение про формирование содержания.

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

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

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



К чему это я. Выше писали, что есть два содержания: слева и после титульного листа. На самом деле содержание только одно, то которое видно в документе, "после тиnульного листа" (хотя оно может быть где угодно, хоть в конце). Другими словами, то, которое распечатывается.
А то, что отображается во многих программа слева - это структура документа в соответствии с заголовками (вернее список закладок на структурные элементы).
Если делается автоматическое оглавление "после титульного листа", то структура документа есть по-умолчанию (иначе автоматическое оглавление не сделается  ;D ). Поэтому не должно быть причины обсуждать, какое же из двух содержаний делать.

А вот если убрать галочку с экспорта закладок, то просмотрщик PDF структуру уже не увидит, но гиперссылки работать будут.

Извините, если я ошибаюсь.

Оффлайн Пользователь.

  • Местный
  • *****
  • Автор темы
  • Сообщений: 4500
Re: Как написать инструкцию
« Ответ #8 : Февраль 21, 2015, 20:37:06 »
Ты не учел что можно еще вручную создать содержание в боковой панели. В этом случае содержание запросто делается без содержания для печати.

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

Оффлайн Пользователь.

  • Местный
  • *****
  • Автор темы
  • Сообщений: 4500
Re: Как написать инструкцию
« Ответ #9 : Май 02, 2018, 10:37:34 »
Нынешняя ситуация с хостингом изображений подтолкнула пересмотреть взгляд на составление документации.

Текст должен быть понятным без изображений.

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

Оффлайн sfs

  • Местный
  • *****
  • Сообщений: 700
    • PuppyRus-Arch
Re: Как написать инструкцию
« Ответ #10 : Май 03, 2018, 12:34:19 »
Почему не хотите поднять wiki?

Оффлайн Пользователь.

  • Местный
  • *****
  • Автор темы
  • Сообщений: 4500
Re: Как написать инструкцию
« Ответ #11 : Май 03, 2018, 15:08:32 »
Это нужно договариваться с админом, а не со мной.

Раздел инструкций на форуме она не заменит, вики ubuntu.ru она не заменит.