Документерра — это универсальное онлайн-решение, которое помогает вам создавать, разрабатывать, размещать и публиковать руководства пользователя, мануалы и другие виды постраничной документации.
В этом разделе описаны основные понятия, необходимые для работы с вашим порталом документации, а также упомянуты ключевые возможности Документерры, которые позволят вам сэкономить массу времени и усилий при написании документации.
Портал документации
Ваш портал документации — это единое место, где технические писатели работают над контентом, а ваши клиенты читают руководства пользователя. Благодаря архитектуре Документерры авторы могут создавать новый контент, не затрагивая то, что видят читатели.
У каждого портала документации есть уникальный адрес вида: portal-name.documenterra.net. Разумеется, вы можете изменить его на собственный домен по вашему выбору: Пользовательское доменное имя для вашего портала.
Вот как выглядит базовая иерархия портала:
Проект — это контейнер, в котором хранятся создаваемые вами разделы документации. Проекты представляют собой вашу рабочую область, и именно здесь вы и ваша команда будете работать над фактическим содержимым.
Каждый проект состоит из страниц. Страница — это отдельная структурная часть вашего проекта. Можно представить её как отдельную статью или раздел документа. Разделение одного длинного пользовательского руководства на набор меньших по объему, логически организованных страниц, и является основной идеей подхода к постраничному созданию документации.
В Документерре проекты доступны только авторам. Читатели могут видеть документацию только онлайн после ее публикации или офлайн после создания скачиваемой версии. Когда проект публикуется, его содержимое «дублируется» в новую сущность, называемую публикацией, или в скачиваемое руководство. Чтобы узнать больше о проектах, онлайн-публикациях и их различиях, обратитесь к разделу: Проекты и Публикации.
Единый источник
Единый источник включает в себя несколько инструментов, которые решают большинство задач по повторному использованию готового контента или созданию разных вариаций документации из одного исходного материала.
- Создание документации | Повторно используйте контент
- Использование переменных в тексте
- Условный контент
- Сниппеты
Рабочий процесс и ревью
Документерра предлагает все необходимые инструменты для выстраивания удобного рабочего процесса, эффективного взаимодействия между авторами и упрощения процесса проверки и утверждения материалов.
Подробнее читайте в разделе Рабочий процесс и ревью.
Перевод
Вы можете локализовать вашу документацию на разные языки, используя встроенную экосистему перевода/локализации, так что вам не потребуются сторонние решения, если нужно перевести ваш контент. Также поддерживается машинный перевод.
Узнать больше: Создание многоязычной документации.
API
С помощью API Документерры можно автоматизировать задачи, интегрировать документацию во внешние процессы, создавать сложные сценарии и многое другое.
Подробнее читайте в разделе API Документерры.