Wiki и база знаний

Назначение

Раздел описывает ведение корпоративной базы знаний в Dinext: пространства Wiki, публичные страницы для читателей, административную зону для авторов и редакторов, согласование изменений перед публикацией и управление доступом к знаниям.

Цели и задачи

• Организовать несколько независимых баз знаний для продуктов, процессов, проектов или внешней документации.
• Публиковать инструкции и справочные материалы на отдельных URL с навигацией, оглавлением и поиском.
• Редактировать содержимое через визуальный Markdown-редактор с поддержкой rich content.
• Согласовывать изменения через change requests до публикации.
• Управлять правами чтения, редактирования и публикации на уровне пространства Wiki.
• Собирать обратную связь от читателей и контролировать качество ссылок.
• При необходимости синхронизировать пространство с GitHub-репозиторием, где кодовая документация остается источником правды.

Для кого

• Читатели, которым нужны опубликованные инструкции, регламенты и ответы.
• Авторы и редакторы, которые создают страницы, группируют материалы и отправляют изменения на review.
• Рецензенты и ответственные за публикацию, которые проверяют правки и выполняют merge.
• Администраторы Wiki, которые управляют пространствами, ролями, настройками, брендингом, GitHub-синхронизацией и отчетами качества.
• Руководители проектов, продуктовые команды и поддержка, которые используют Wiki как единый источник знаний.

Основные понятия

• Пространство Wiki — отдельная база знаний или раздел документации со своим маршрутом публикации, настройками, ролями, брендингом и деревом страниц.
• Публичный reader — опубликованная часть Wiki, которую читатели открывают по маршруту пространства, например /docs.
• Административная зона /wiki — защищенная зона для управления пространствами, деревом страниц, редактором, change requests и настройками.
• Страница Wiki — единица содержимого в дереве пространства. Страница может быть опубликованной или скрытой.
• Группа страниц — узел дерева, который помогает организовать структуру и навигацию.
• Внешняя ссылка — элемент дерева Wiki, который ведет на внешний ресурс.
• Change request — заявка на изменение страницы или структуры Wiki: создание, редактирование, перемещение, удаление, публикация или снятие с публикации.
• Git-synced пространство — пространство, которое синхронизируется из GitHub-репозитория и редактируется вне Wiki UI.

Основные сущности / объекты

• Пространство Wiki — настройки публикации, доступа, брендинга, обратной связи и GitHub-синхронизации.
• Дерево страниц — структура групп, страниц и внешних ссылок внутри пространства.
• Страница — опубликованный или черновой материал с Markdown-содержимым, метаданными для поиска и карточкой настроек.
• Редактор — визуальная среда для текста, таблиц, изображений, видео, PDF, iframe-вставок, диаграмм, callouts и кода.
• Change request — рабочий объект согласования изменений: черновик, review, одобрение, merge или отклонение.
• Настройки Wiki — глобальные параметры оглавления, feedback, WebP-конвертации, пользовательского оформления и GitHub App.
• Отчеты качества — обратная связь читателей и отчет по битым ссылкам.

Основные сценарии / процессы

Чтение опубликованной Wiki

1. Читатель открывает публичный маршрут пространства Wiki.
2. В боковой панели выбирает раздел или страницу.
3. Использует breadcrumbs, оглавление страницы, предыдущую/следующую страницу и поиск по Wiki.
4. При необходимости копирует страницу как Markdown, скачивает PDF или открывает материал во внешнем ИИ-инструменте.
5. Если включена обратная связь, оставляет реакцию или комментарий по качеству страницы.

Создание и редактирование страницы

1. Автор входит в административную зону /wiki.
2. Выбирает пространство и открывает дерево страниц.
3. Создает страницу, группу или внешнюю ссылку; при необходимости меняет порядок элементов дерева.
4. Открывает страницу в редакторе и заполняет содержимое. Редактор поддерживает заголовки, списки, таблицы, task list, цитаты, code blocks, ссылки, изображения, видео, PDF, iframe, Mermaid-диаграммы и callouts.
5. Настраивает метаданные страницы: заголовок, описание и изображение для предпросмотра.
6. Сохраняет изменения вручную или через автосохранение.

Согласование изменений

1. Автор готовит изменения в draft change request.
2. Передает заявку на review.
3. Рецензент проверяет diff, предпросмотр и связанные изменения.
4. Рецензент может одобрить заявку, запросить доработку или отклонить ее.
5. После одобрения пользователь с правом публикации выполняет merge, и изменения становятся опубликованными.
6. Если при merge возникает конфликт, его нужно разрешить перед публикацией.

Настройка пространства Wiki

1. Администратор создает или открывает пространство Wiki.
2. Указывает маршрут публичной публикации и решает, будет ли пространство опубликовано.
3. Настраивает роли чтения и записи, возможность вкладов от читателей, публичный гостевой доступ и feedback.
4. При необходимости задает логотип, favicon, ссылки навигации, элементы app switcher и пользовательское оформление.
5. Для пространства, синхронизируемого с GitHub, указывает репозиторий, ветку, каталог и запускает синхронизацию.

GitHub-синхронизация

1. Администратор настраивает GitHub App и создает git-synced пространство.
2. GitHub становится источником правды для содержимого этого пространства.
3. Пользователи читают страницы в Wiki, но не редактируют их в Wiki UI.
4. Автор открывает страницу для редактирования в GitHub.
5. Синхронизация запускается вручную через Sync now или автоматически по webhook после push.

Правила и ограничения

• Доступ задается ролями Wiki и правами на уровне пространства: Read и Write.
• Пространство без ограничивающих ролей доступно вошедшим пользователям согласно настройкам; гостевой доступ возможен только если он явно разрешен.
• Параметр вкладов определяет, могут ли читатели предлагать изменения через change request.
• Git-synced пространства редактируются в GitHub, поэтому в Wiki UI они доступны только для чтения и синхронизации.
• Merge change request возможен только после одобрения. Отклоненная заявка не публикуется.
• Неопубликованные пространства и страницы недоступны читателям публичного reader.
• Поиск Wiki фильтрует результаты по правам доступа пользователя.
• Обратная связь читателей может быть ограничена по частоте, чтобы не превращаться в спам.
• Содержимое хранится как Markdown, но пользователь редактирует его через визуальный редактор.

Результаты / отчетность

• Опубликованная база знаний с деревом страниц, поиском, оглавлением и мобильной навигацией.
• Управляемый поток изменений: draft, review, approve, merge.
• История change requests и решений рецензентов.
• Обратная связь читателей по опубликованным страницам.
• Отчет по битым ссылкам для контроля качества базы знаний.
• Журнал синхронизации для GitHub-связанных пространств.

Типовые вопросы и ошибки (FAQ)

Где находится Wiki?

Публичная Wiki открывается по маршруту конкретного пространства, например /docs. Административная зона для авторов и администраторов находится по адресу /wiki. Плитка приложения может быть доступна только пользователям с управленческими ролями, но доступ к /wiki дополнительно зависит от прав на пространство.

Почему я не могу редактировать страницу?

Возможные причины: у вас нет Write-доступа к пространству, вклады от читателей выключены, страница находится в git-synced пространстве или change request уже находится на review и требует действий рецензента.

Как откатить страницу к предыдущей версии?

В текущей пользовательской модели Wiki публикация выполняется через change request и merge. Если нужно исправить опубликованную страницу, создайте новый change request с нужным содержимым и проведите его через review. Не следует рассчитывать на отдельное действие «восстановить ревизию», если оно не доступно в интерфейсе конкретной установки.

Чем публичная Wiki отличается от /wiki?

Публичная Wiki предназначена для чтения: навигация, поиск, оглавление, feedback, экспорт и ссылки. /wiki — рабочая зона авторов и администраторов: пространства, дерево страниц, редактор, заявки на изменения, review и настройки.

Можно ли связать Wiki со справочными статьями поддержки?

Wiki и база знаний описывает отдельный контур публикации и согласования документации. Справочные статьи поддержки относятся к другому процессу и не являются основным объектом Wiki. Если в компании нужна связь с поддержкой, ее нужно описывать как отдельный сценарий Service Desk.

Почему поиск не показывает страницу?

Проверьте, опубликована ли страница, есть ли у пользователя доступ к пространству и не является ли страница группой без собственного содержимого. Поиск Wiki возвращает только доступные пользователю опубликованные страницы.

Когда использовать GitHub-синхронизацию?

GitHub-синхронизация подходит для технической или продуктовой документации, где исходные Markdown-файлы ведутся вместе с кодом. В этом режиме GitHub является источником правды, а Wiki используется для публикации, чтения, поиска и навигации.

Связанные темы

• Service Desk
• Workflow
• Роли и полномочия
• Уведомления
• Файловое хранилище
• Диск и документы
• Подключение ИИ