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

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

by
Read Time:5 minsLanguages:

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

Техническая документация основана на эффективной технической информации пользователя. Она либо объясняет, как что-то работает, либо как это использовать. Для разных людей оно обозначает что-то конкретное. Вам может понадобиться такая документация для новых сотрудников, чтобы объяснить им новые функции или для людей, не разбирающихся в технологии.

Написание технической документации требует ряда инструментов — приложение для скриншотов, редактор изображений, текстовый редактор для написания инструкции и инструменты для обмена документами.

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

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

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

Причины для выбора Clarify

  1. Clarify это крос-платформенное приложение, доступное как для компьютеров Windows, так и для Mac. Он совместим с версиями Windows Vista до 10 и OS X 10.7 Lion до 10.11 El Capitan и macOS 10.12 Sierra
  2. Оно позволяет вам создавать технические документы небольшими порциями и объяснять их шаг за шагом. Вы можете добавлять изображения, комментировать их посредством графического интерфейса и добавлять текст для объяснения шагов.
  3. Оно имеет встроенную интеграцию инструментов, позволяющих вам обмениваться документами через Интернет, электронную почту и Evernote. Вы также можете сохранить их в PDF, HTML и документ Word
  4. Оно позволяет создавать собственные шаблоны HTML и PDF, поэтому вы можете сосредоточиться на задаче создания технического документа и не беспокоиться о логотипах, шрифтах, цветах, верхнем и нижнем колонтитулах, разрывах страниц и т.д.

Настройка Clarify

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

Вы увидите три опции: General, Share и PDF Templates. Каждая опция позволяет вам настроить несколько параметров.

Общие настройки

general-settings-clarify-preferencesgeneral-settings-clarify-preferencesgeneral-settings-clarify-preferences
Выберите общие настройки в настройках Clarify

Настройте горячие клавиши для снятия скриншотов. Чтобы изменить горячую клавишу, нажмите Remove и введите новую горячую клавишу. Если вы предпочитаете большой холст для написания технических документов, переключите Document editor text size (размер текста редактора документов) с small на large.

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

Поделиться

share-settings-clarify-preferencesshare-settings-clarify-preferencesshare-settings-clarify-preferences
Перейдите в настройки Clarify > Share. Нажмите кнопку +, чтобы добавить учетную запись

Clarify предлагает несколько способов передать созданные документы. Вы можете экспортировать в clarify-it.com, чтобы остальные могли просматривать документы оттуда. Вы можете экспортировать документы в пользовательский блог WordPress или блог .com или сохранить их как документ PDF, HTML или Word.

Шаблоны для формата PDF

Clarify поставляется с четырьмя основными шаблонами: Basic, Black and White, Chrome и Corporate.

Если у вас есть определенные потребности, вы можете создать свой собственный PDF-шаблон. Нажмите кнопку +, чтобы создать новый настраиваемый шаблон.

customize-general-settings-pdf-templatecustomize-general-settings-pdf-templatecustomize-general-settings-pdf-template
Настройка общих параметров шаблонов PDF. Нажмите +, чтобы добавить свой шаблон.

На вкладке General можно настроить размер страницы и поля, выравнивание изображения, настроить выравнивание текста и многое другое. При создании PDF-документа Clarify добавляет разрывы страниц в определенных местах. Хотя Clarify пытается сохранить содержимое раздела вместе, вы можете это настроить.

Откройте меню Content Flow, чтобы настроить параметры разрыва страницы. Выберите One step per page, чтобы добавить разрыв страницы после каждого шага.

Выберите Fit as content as possible per page, чтобы разместить как можно больше контента на странице. Используйте CSS для дальнейшего контроля над разрывами страниц.

В поле заголовка вы можете добавить Logo и настроить ещё несколько переменных. Вы можете добавить такие переменные как:

  • [[Document Title]] — Название документа
  • [[File_Name]] — Название PDF файла
  • [[Date]] — Дата в формате, который использует ваша система
  • [[MM/DD/YYYY]] — Месяц, день и год

В поле нижнего колонтитула вы можете добавить номера страниц и текст нижнего колонтитула. Вы можете добавить такие переменные, как:

  • [[Page_Number]] — Номер страницы
  • [[Page_Count]] — Общее количество страниц
customize-fonts-colours-pdf-templatecustomize-fonts-colours-pdf-templatecustomize-fonts-colours-pdf-template
Настройка шрифтов и цветов в шаблоне PDF

На вкладке Fonts & Colors установите шрифт, размер и цвет шрифта по умолчанию для верхнего и нижнего колонтитула, описания статьи, заголовка раздела и подзаголовка. Если вы не устанавливаете шрифт для определенного объекта, тогда он будет использовать шрифт по умолчанию — Default Font.

customize-css-pdf-template-clarifycustomize-css-pdf-template-clarifycustomize-css-pdf-template-clarify
Настройка CSS для PDF-шаблона. Знание CSS позволяет вам добавить много переменных.

Вкладка Custom CSS вы можете вносить корректировки в элементы, которые недоступны в пользовательском интерфейсе. PDF-шаблоны в Clarify работают по принципу HTML и CSS. Если вы знаете оба языка, то вы можете добавить много переменных в шаблон PDF. Например:

.step-container (
page-break-after: always
)

Этот CSS сообщает генератору PDF всегда добавлять разрыв страницы после шага. Вы также можете добавить стиль шрифта в ваш PDF-документ, добавив в него определенные классы CSS.

.step-title (
font-style: italic;
font-weight: lighter;
)

Вот некоторые классы, которые вы можете использовать: article-description, step-title, step-container, sub-step и step-instructions. На каждом шаге вы можете нажать Preview (Просмотр), чтобы увидеть окончательный вид шаблона PDF.

Заключение

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

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

В следующем уроке я дам пошаговую процедуру создания технического документа. Приложение включает 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.