Аналог Confluence
Confluence хранит документацию страницами в пространствах. В Skillok документация — это markdown-файлы в репозитории, и с ней работают как с кодом — правка, история, ревью. Это строже и прозрачнее, но без визуального конструктора страниц и совместной правки в реальном времени.
В этой статье
Как выглядит документация в Skillok#
- Раздел документации — папка, страница — markdown-файл. README в корне
репозитория показывается на его главной странице — удобное оглавление. - Разметка: заголовки, таблицы, списки задач, выноски
> [!NOTE], формулы,
диаграммы Mermaid, код с подсветкой, ссылки между страницами. - Правка прямо в браузере или локально в любом редакторе с отправкой через git.
- У каждой страницы — полная история: кто, когда и что изменил, с
возможностью открыть любую прежнюю версию.
Ревью документации#
Важное изменение — регламент, архитектурное решение, инструкция для клиентов —
можно не публиковать сразу, а предложить запросом на слияние. Коллеги
оставляют комментарии, одобряют или просят доработать, и только после этого
текст попадает в основную ветку. Файл CODEOWNERS назначает ответственных за
разделы.
Доступ#
Документацию команды держи в закрытом репозитории организации. Доступ
выдаётся командам и людям с ролями: только просмотр, разбор задач, правка,
сопровождение. Публичную документацию — в открытом репозитории.
Чего нет#
- визуального редактора страниц с макросами и встраиваемыми блоками;
- совместной правки одной страницы в реальном времени;
- комментариев прямо к строке текста в интерфейсе;
- поиска по содержимому документов — только поиск файла по имени внутри
репозитория; - импорта пространств Confluence.
Как перенести#
Выгрузи страницы из Confluence в доступном у тебя формате и сохрани их
как markdown — это можно сделать конвертером или вручную для ключевых
страниц. Разложи по папкам, загрузи в репозиторий и проверь ссылки
между страницами. Переезд — хороший повод выбросить устаревшее.
Кому подходит#
Техническим командам, которые и так пишут в markdown, и компаниям, где
документация должна меняться прозрачно — с историей и согласованием.
Попробовать на своей задаче
Создай репозиторий — история изменений, задачи и запросы на слияние будут с первого дня.
Было полезно?