Unlimited WordPress themes, graphics, videos & courses! Unlimited asset downloads! From $16.50/m
Advertisement
  1. Computer Skills
  2. Documentation

Как создать профессиональную техническую документацию — Часть 2

by
Read Time:9 minsLanguages:

Russian (Pусский) translation by Ellen Nelson (you can also view the original English article)

Создание технического документа

У вас новый Mac и вы хотите настроить Интернет для доступа в Интернет. Вы боитесь, что вы забудете шаги или будете полезны другим. В этом примере я создам простой пошаговый технический документ и сохраню его как PDF-документ.

1. Добавьте тему и описание статьи.

Напишите тему (Subject) и краткое описание статьи (Article Description). Оно должен быть коротким, понятным и точно описывать то, что вы хотите показать, в этом случае вы хотите настроить Интернет на Mac. Строка Subject появится на боковой панели инструментальной панели Clarify.

Нажмите File > Save As и выберите папку, в которой должен быть сохранен файл. По умолчанию он выбирает тему документа Clarify в качестве имени файла с расширением .clarify и сохраняет его в папке Clarify Documents.

create-subject-and-article-descriptioncreate-subject-and-article-descriptioncreate-subject-and-article-description
Создаём тему и описание статьи

2. Добавление текста заголовка и абзаца

Нажмите +, чтобы добавить новый шаг. Напишите заголовок шага (Step Title) и абзац текста в соответствующих полях.

Если вы допустили ошибку, нажмите на поле, чтобы его отредактировать. Когда вы добавляете Step Title, вы увидите заголовок шага в боковой панели инструментов Clarify.

create-step-title-and-paragraph-textcreate-step-title-and-paragraph-textcreate-step-title-and-paragraph-text
Создание заголовка шага и текста абзаца. 1. Название шага 2. Текстовое поле абзаца

3. Форматирование текста абзаца

Clarify предлагает несколько вариантов форматирования текста. Панель форматирования появится, когда вы выберете текстовое поле. Щелкните один из значков, чтобы изменить формат текста. Вы можете выбрать полужирный, курсив, маркированный список, ссылку, верхний индекс и другие.

Clarify создаст новый абзац по Enter. Clarify добавляет расстояние между каждым абзацем такое, как вы увидите в тексте на веб-сайте.

paragraph-formatting-option-clarifyparagraph-formatting-option-clarifyparagraph-formatting-option-clarify
Различные варианты форматирования абзацев в Clarify

Clarify также позволяет форматировать код, как блоки кода, так и отдельные слова в предложении. Чтобы форматировать слово или два в качестве кода, выберите слово и нажмите кнопку Format as code на панели инструментов форматирования.

При экспорте документа Clarify в формате HTML текст будет заключен в <code>...</code>. Выберите весь абзац и нажмите Format as code, чтобы преобразовать текст в блок кода с выводом, заключенным в <pre><code>...</code></pre>.

code-formatting-clarifycode-formatting-clarifycode-formatting-clarify
Опции форматирования кода в Clarify

4. Делаем скриншоты

У вас есть три варианта снятия скриншотов:

  1. Кнопка Capture в приложении Clarify
  2. Кнопка Capture на панели меню, или
  3. Сочетание клавиш

Перейдите в параметры настройки горячих клавиш Clarify > Preferences > General.

take-screenshot-from-capture-buttontake-screenshot-from-capture-buttontake-screenshot-from-capture-button
Снятие скриншотов кнопкой Capture

Когда вы нажимаете кнопку Capture, на экране появляется инструмент для снятия скриншотов. Перетащите эту область туда, где вы хотите сделать скриншот и нажмите Enter. Нажмите пробел для захвата всего экрана. Нажмите пробел снова, чтобы вернуться к режиму захвата области.

Нажмите R для прокрутки областей, которые вы снимали ранее. Это полезно, если вы хотите заснять туже саму область экрана снова и снова. Нажмите C, чтобы спрятать или показать курсор при снятие скриншота.

screen-capture-tool-clarifyscreen-capture-tool-clarifyscreen-capture-tool-clarify
Инструмент для снятия скриншотов. В нём есть несколько кнопок для упрощения этого процесса.

5. Выполнение основных задач с изображениями

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

Чтобы повернуть изображение, нажмите Edit > Rotate Image.

rotate-image-clarifyrotate-image-clarifyrotate-image-clarify
Поворот изображения в Clarify

Чтобы обрезать изображение, нажмите Edit > Crop Image. Нажмите и перемещайте область, которую хотите сохранить, и нажмите клавишу Enter.

crop-image-clarifycrop-image-clarifycrop-image-clarify
Обрезка изображения в Clarify

Вы можете выбрать один из нескольких инструментов аннотации. Выберите изображение и выберите тип инструмента аннотации, который вы хотите использовать с панели инструментов форматирования: Линия (Line tool), Квадрат (Square tool), Окружность (Circle tool), Sequence Numbering tool — инструмент нумерации последовательностей (вы можете настроить начало отсчёта), текст (Text tool) и размытие (Blur tool).

type-of-line-annotation-toolstype-of-line-annotation-toolstype-of-line-annotation-tools
Типы инструментов аннотации в Clarify

У Clarify есть три варианта изменения размеров изображений. На нем есть четыре «ручки» вокруг сторон редактора изображений. Нажмите и перетащите любую из них, чтобы изменить размер холста. Вы не можете кадрировать изображение, используя эти ручки.

Перетащите и удерживайте клавишу Option (это для Mac, в Windows другая клавиша), чтобы изменить размер всех сторон холста одинаково.

resize-canvas-through-handlesresize-canvas-through-handlesresize-canvas-through-handles
Изменение размера изображения с помощью ручек

Используйте уголок изменения размера изображения, расположенный в нижнем правом углу. Нажмите и перетащите этот уголок, чтобы изменить размер изображения. Нажмите и удерживайте клавишу Option, чтобы изменять размер изображения с шагом в 10%.

resize-image-through-handleresize-image-through-handleresize-image-through-handle
Изменение размера изображения с помощью уголка, расположенного в нижнем правом углу.

Для точного контроля размера изображения нажмите на изображение шага и выберите Resize Image…. Если на этапе есть несколько изображений, вы должны выбрать конкретное изображение, а затем изменить его размер с помощью контекстного меню.

resize-image-context-menuresize-image-context-menuresize-image-context-menu
Изменение размера изображения с помощью контекстного меню

6. Создание подшагов или вложенных шагов

Clarify имеет возможность создавать подшаги. Подшаг с отступом под родительским шагом и может быть глубиной в один уровень. При экспорте документа фрагмент подшага будет выглядеть по-другому с небольшим размером шрифта, нумерацией подшагов (если вы включите это). Сначала создайте обычный шаг, как описано выше.

Выберите шаг, который вы хотите сделать подшагом. Перейдите в меню Document > Move Step и переместите шаг вправо, чтобы сделать отступ. Переместите подшаг вверх или вниз, чтобы реорганизовать технический документ, если требуется.

creating-substeps-clarifycreating-substeps-clarifycreating-substeps-clarify
Создание подшагов в Clarify

7. Автоматическая нумерация шагов

Когда технический документ включает в себя несколько шагов, вы можете добавить цифру в качестве префикса. Clarify будет автоматически нумеровать шаги, нажмите Document Inspector и отметьте Auto-number Steps. Все остальные шаги будут автоматически начинаться с цифр.

auto-number-steps-clarifyauto-number-steps-clarifyauto-number-steps-clarify
Автоматическая нумерация шагов в Clarify

Чтобы исключить шаг из получения префикса с номером, нажмите Step Inspector и отметьте Exclude from Auto-number. Этот шаг больше не будет содержать префикс с номером.

exclude-a-step-clarifyexclude-a-step-clarifyexclude-a-step-clarify
Исключение шага в Clarify

Могут возникнуть ситуации, когда вы не хотите автоматически указывать шаги верхнего уровня, а только подшаги. Чтобы сделать это, нажмите Step Inspector и отметьте Auto-number substeps. Только подшаги будут начинаться с цифр.

auto-number-substepsauto-number-substepsauto-number-substeps
Автонумерация подразделов в Clarify. Если эта функция не работает, тогда, наверно, это ошибка.

8. Выполнение расширенных задач с изображениями

Clarify включает некоторые сложные функции для управления изображениями. Хотя эти функции доступны в других редакторах изображений, их использование в Clarify значительно ускоряет процесс создания технического документа. Чтобы добавить рамку вокруг изображений, выберите шаги, которые вы хотите отредактировать.

Нажмите Step Inspector и в разделе Image Settings измените границу изображения — Image Border, которую вы хотите задать для изображений. Вы можете выбрать линия (Line), картинная рамка (Picture frame) и скруглённые углы (Rounded Corners).

add-image-border-clarifyadd-image-border-clarifyadd-image-border-clarify
Добавление границы изображения в Clarify. Вы можете выбрать линию, картинная рамка и скругленные углы.

Clarify может автоматически масштабировать изображения и уменьшать их, если они слишком высоки или широки.

Нажмите Document Inspector и установите флажок Auto scale images. Установите максимальную высоту или ширину изображения или и то и то.

automatically-scale-images-clarifyautomatically-scale-images-clarifyautomatically-scale-images-clarify
Автоматическое масштабирование изображений в Clarify без использования редактора изображений

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

Сделайте скриншот, и они окажутся в шаге.

adding-multiple-images-to-a-stepadding-multiple-images-to-a-stepadding-multiple-images-to-a-step
Добавление нескольких изображений в один шаг легко и без усилий

Если вы настроили повтор последнего скриншота (Repeat Last Screenshot), вам не нужно беспокоиться о инструментах захвата экрана. Изображение добавляется чуть ниже верхнего изображения и так далее.

adding-multiple-images-in-single-stepadding-multiple-images-in-single-stepadding-multiple-images-in-single-step
Добавление нескольких изображений в один шаг. Если вам нужно сделать скриншот одной и той же области несколько раз, настройте горячую клавишу на Repeat Last Screenshot

Если вы хотите заменить изображение для определенного шага, выберите изображение, которое хотите заменить, затем щелкните значок Replace Image в верхнем левом углу.

Или щелкните значок Replace, расположенный рядом с холстом.

replace-image-clarifyreplace-image-clarifyreplace-image-clarify
Заменить изображение в Clarify 1. Значок Replace 2. Значок Replace рядом с маркером холста

9. Встраивание видео из интернета

Технический документ будет легко проследовать, если вы добавите видео. С помощью Clarify вы можете легко вставлять видеоролики, размещенные на видеосервисах, таких как YouTube.

Выделите шаг, нажмите Step Inspector и измените Media Type с Image на HTML.

change-media-type-in-step-inspectorchange-media-type-in-step-inspectorchange-media-type-in-step-inspector
Изменение типа медиа в инспекторе шагов с изображения на HTML

При этом вы увидите окно для вставки HTML-кода. Перейдите на YouTube и скопируйте код для вставки видео. Нажмите Preview, чтобы просмотреть предварительный просмотр HTML.

paste-embed-code-in-boxpaste-embed-code-in-boxpaste-embed-code-in-box
Вставьте код для вставки в поле. Выберите код для вставки из видео на YouTube

Некоторые форматы экспорта не могут отображать HTML для шага. Нажмите на вкладку Image и добавьте изображение для этих форматов экспорта.

Вы всегда должны использовать представление изображения при экспорте документа Clarify в Word (расширение DOCX).

add-image-to-see-htmladd-image-to-see-htmladd-image-to-see-html
Добавить изображение для HTML просмотра

10. Добавление якоря к шагам в HTML-выводе

Вы можете добавить теги-якоря́ к шагам, которые будут назначаться как id свойство в HTML-выводе. Это может быть полезно для прямой привязки к конкретным шагам при публикации документа Clarify в Интернете.

Например, если вы зададите имя привязки для шага как special-step и если URL-адрес вашего документа Clarify:

https://www.myblog.com/my-article.html

То вы можете перейти непосредственно к шагу, добавив #special-step к URL-адресу:

http://www.myblog.com/my-article.html#special-step

Чтобы добавить теги привязки к шагу, выберите шаг, который нужно изменить. Нажмите Step Inspector и в поле Step Settings задайте имя якоря.

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

add-anchor-tags-to-stepsadd-anchor-tags-to-stepsadd-anchor-tags-to-steps
Добавление тегов привязки к шагам в документе Clarify

Примечание. Если вы не установите привязку для шага, то Clarify автоматически создаст теги на основе внутреннего id, который Clarify назначает на шаги, при их создании. Эти теги привязки будут оставаться неизменными каждый раз, когда вы экспортируете документ Clarify.

11. Экспортирование и отправка документа Clarify

Выберите Clarify > Preferences и нажмите поделиться (Share). Нажмите кнопку + и выберите учетную запись для экспорта. Аккаунт общего доступа может экспортировать в Clarify-it.com, WordPress и Evernote. Вы также можете экспортировать документ Clarify в формате PDF, HTML и Word.

Чтобы иметь возможность поделиться, вы должны иметь учетную запись и быть авторизованы в системе. Для PDF, HTML, выберите или настройте шаблон, который вы хотите использовать каждый раз (при экспорте).

share-accounts-in-clarifyshare-accounts-in-clarifyshare-accounts-in-clarify
Создание аккаунтов в Clarify

Вы можете настроить шаблон для PDF, HTML, Электронной почты и Word. Шаблон HTML вы можете выбрать из нескольких шаблонов: Basic, Chrome, Corporate, Markdown, Technical и даже собственный шаблон HTML.

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

html-template-clarifyhtml-template-clarifyhtml-template-clarify
Настройка шаблона HTML в Clarify

Вы можете настроить шаблон электронной почты аналогичным образом. Поскольку будет использоваться PDF, вы можете настроить шаблон PDF и выбрать почтовый клиент: Apple Mail, Postbox, Outlook или Airmail. Нажмите кнопку Preview, чтобы увидеть шаблон, который вы настроили.

email-template-clarifyemail-template-clarifyemail-template-clarify
Шаблон сообщения электронной почты в Clarify. Выберите почтовый клиент, который вы предпочитаете

Заключение

Clarify — это родное приложение для Windows и Mac для создания технической документации. Оно позволяет создавать шаблоны, чтобы вы могли сосредоточиться на создании технического документа без суеты и работы в нескольких приложениях — инструментом захвата экрана, текстовым процессором и инструментами обмена.

В этом уроке я показал пошаговую процедуру создания технического документа. Приложение включает 14-дневную пробную версию и доступно за 29,99 долларов США. Подробнее смотрите информацию о ценах.

Advertisement
Advertisement
Looking for something to help kick start your next project?
Envato Market has a range of items for sale to help get you started.