Doctave
Doctave — це платформа для документації, яка дозволяє командам створювати, керувати та публікувати технічну документацію за допомогою простого робочого процесу на основі Git.
Що таке Doctave
Doctave — це платформа для документації, яка поєднує гнучкість написання в Markdown із потужністю професійного хостингу документації. Ви пишете свою документацію у звичайних текстових файлах, зберігаєте їх у Git разом із кодом, а Doctave перетворює їх на красиві, пошукові вебсайти документації.
Платформа підтримує як звичайні керівництва в Markdown, так і специфікації OpenAPI для документації API. Вона автоматично створює попередні середовища, коли ви вносите зміни, щоб ваша команда могла переглядати оновлення перед публікацією. Усе зберігається у вашому репозиторії Git, що дає вам повний контроль версій над документацією.
Doctave Studio — це супутній настільний додаток, який надає попередній перегляд у реальному часі, підказки автозаповнення, перевірку битих посилань і перевірку орфографії. Разом ці інструменти допомагають командам створювати документацію, що залишається актуальною та точною.
Як використовувати Doctave
Почати роботу з Doctave дуже просто. Ось як ефективно його використовувати:
Створіть папку з документацією у вашому репозиторії коду та напишіть свій контент, використовуючи файли Markdown. Включіть файл README.md як стартову сторінку.
Встановіть Doctave Studio на свій комп’ютер, щоб переглядати документацію локально з оновленнями в реальному часі під час написання.
Налаштуйте файл конфігурації doctave.yml, щоб визначити структуру документації, кольори теми та навігаційні посилання.
Підключіть свій Git-репозиторій до Doctave через їхню платформу. Кожного разу, коли ви робите push змін, Doctave автоматично оновлює опубліковану документацію.
Для документації API додайте файл специфікації OpenAPI до вашого репозиторію. Doctave автоматично згенерує інтерактивні сторінки з API-довідником.
Використовуйте гілки Git для керування різними версіями документації. Створюйте pull-запити для перегляду змін перед публікацією, і Doctave згенерує посилання для перегляду для кожного pull-запиту.
Функції Doctave
Git-основний робочий процес документації з контролем версій
Настільний редактор Doctave Studio з попереднім переглядом у реальному часі
Підтримка специфікації OpenAPI для документації API
Автоматичні середовища попереднього перегляду для pull-запитів
Управління документацією кількох версій
Вбудований пошук по всьому вмісту
Опції кастомного брендування та темізації
Аналітика читачів та збір відгуків
Інтеграція CI/CD для автоматичного розгортання
Опції документації з захистом паролем
Ціноутворення Doctave
Startup
$99 /міс
- Необмежена кількість проєктів
- 1 власний домен
- Включено 5 користувачів
- Робочий процес на основі Git
- Підтримка OpenAPI
- Попередні середовища
- Вбудований пошук
- Аналітика та відгуки
- Індивідуальний брендинг
Growth
$399 /міс
- Необмежена кількість проєктів
- 5 користувацьких доменів
- 10 користувачів включено
- Всі функції для стартапів
- Покращені інструменти для співпраці
- Пріоритетна підтримка
- Розширене керування версіями
- Документи з паролем
Scale
$1000 /міс
- Необмежена кількість проєктів
- Необмежена кількість власних доменів
- 25 користувачів включено
- Всі функції Growth
- Безпека корпоративного рівня
- Виділена підтримка
- Індивідуальні інтеграції
- Гарантії SLA
- Розширена аналітика
Migration Service
$500 одноразово
- Професійна міграція контенту
- Підтримує організацію та форматування
- Безперервна робота сервісу
- Індивідуальне навчання команди
- Допомога з налаштуванням
- Одноразова плата за проєкт
Випадки використання Doctave
Хто може отримати користь від Doctave
Часті запитання про Doctave
Поділіться своїм досвідом з Doctave
Подивіться, що користувачі кажуть про Doctave
0 Огляди
Ще немає оглядів
Будьте першим, хто напише огляд Doctave
Вбудувати значки Doctave
Покажіть своїй спільноті, що Doctave представлений на Tool Questor. Додайте ці красиві значки на свій веб-сайт, документацію або соціальні профілі, щоб підвищити довіру та залучити більше трафіку.
