Документация Wiki — база знаний

Wiki — база знаний команды

Wiki — это документо-ориентированная база знаний, встроенная в Mockarty: дерево
markdown-страниц с полной историей версий, живыми вставками ваших тестовых
артефактов, AI-помощником по написанию и импортом из Confluence или Notion в
один клик. Документация живёт рядом с тестами, моками и досками, которые она
описывает.

Открывается из бокового меню: Wiki (/ui/wiki).

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

Всё является страницей. Страницы складываются в дерево в левой панели —
структурируйте, создавая подстраницы, фильтруйте по заголовку через поиск
сверху.

  • Создать корневую страницу — кнопка +, дочернюю — Подстраница на
    открытой странице.
  • Перемещение / реорганизация — созданием страниц под нужным родителем;
    страницу можно переподчинить, перенос под собственного потомка запрещён.
  • Удаление убирает страницу и всё её поддерево (попадает в корзину вместе с
    остальными удалёнными элементами вашего пространства).
  • Меню строки — правый клик по странице (или Shift+F10 на ней): открыть,
    добавить подстраницу, в избранное, переместить, выбрать, а для требований —
    преобразовать / вернуть.
  • Клавиатура — стрелки ходят по видимым строкам, Enter открывает страницу.
    Дерево выглядит и ведёт себя так же, как деревья досок, моков и тест-кейсов.

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

Редактирование

По умолчанию вы редактируете инлайн — прямо по форматированной странице:
заголовки, жирный, списки, таблицы и код форматируются вживую по мере набора,
как в документе. Отдельной панели с markdown-исходником нет — что видите, то
читатели и получат.

  • Панель форматирования — жирный, курсив, заголовки, списки, цитата, блок
    кода, ссылка, таблица и разделитель в один клик. Работают и markdown-сокращения:
    наберите ## , - , 1. , > или ``` — блок отформатируется сам.

  • Slash-меню — на пустой строке нажмите / и выберите блок (заголовок,
    список, таблицу, код, цитату, разделитель), не отрывая рук от клавиатуры.

  • Таблицы — при вставке таблицы появляется мини-панель: добавить/убрать
    строку или столбец, переключить строку-заголовок; ширину столбца тянут за границу.

  • Режим Markdown — предпочитаете писать сырой markdown? Кнопка Инлайн /
    Markdown
    в панели редактирования переключает на классический редактор
    исходника с превью рядом. Выбор запоминается. В любом режиме страница хранится
    как markdown — история версий, экспорт и Git-синхронизация одинаковы.

  • Меню «Вставка» — кнопка + Вставить собирает все типы контента в одном
    месте: таблица, чек-лист, блок кода, панель, оглавление, Mermaid-диаграмма,
    draw.io-диаграмма, HTML-блок, доска Mockarty, дашборд, живые таблицы
    задач / тест-кейсов / тест-планов и ссылка на другую страницу.

  • Шаблоны страниц — при создании страницы доступны готовые макеты: заметки
    встречи, ADR (решение), ранбук, ретро и how-to.

  • Ctrl+S сохраняет.

  • Каждое сохранение создаёт пронумерованную версию — ничего не теряется.

  • Вложения: перетащите или вставьте изображение, видео или аудио прямо в
    редактор, либо используйте кнопку со скрепкой. Крупные файлы раздаются
    напрямую из объектного хранилища и не нагружают приложение.

  • Голосовые заметки: кнопка с микрофоном записывает голосовое сообщение;
    оно прикрепляется и отображается встроенным аудиоплеером.

История версий

Кнопка История на любой странице открывает панель версий.

  • Каждое сохранение, которое реально меняет страницу, — версия, новые сверху, с
    автором и опциональной заметкой. Повторное сохранение без правок не плодит
    дубль-версию, поэтому история остаётся чистой.
  • Открыть версию для просмотра. Внутри просмотрщика листайте всю историю
    стрелками ◀ / ▶, а кнопка Изменения показывает diff с предыдущей
    версией прямо там — можно пройти эволюцию страницы версия за версией, не
    выходя из окна.
  • Восстановить возвращает версию как текущее содержимое. История только
    дополняется — восстановление само является новой версией, поэтому всегда можно
    вернуться вперёд.
  • Сравнить две версии: отметьте их и нажмите Сравнить выбранные, чтобы
    увидеть построчный diff.

Если кто-то сохранит страницу, пока вы редактируете, ваше сохранение будет
остановлено баннером конфликта, а не молча перезапишет чужую работу. Кнопка
Посмотреть изменения сравнивает версии. Загрузить свежую сначала
спрашивает, можно ли отбросить несохранённый черновик, затем открывает в
редакторе сохранённую другим человеком версию. Внесите своё изменение заново
перед сохранением.

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

Богатый контент и вставки

Кроме обычного markdown страницы поддерживают блоки ниже. Синтаксис
запоминать не нужно
: наберите / на пустой строке в редакторе и выберите из
палитры — все макросы отсюда есть в ней, вместе с заголовками, списками и
таблицами. Ввод руками по-прежнему работает.

  • Панели — :::info, :::warning, :::note, :::success … :::
    оборачивают цветной блок-выноску (тело — обычный markdown).
  • Оглавление — поставьте [[TOC]] на отдельной строке, чтобы получить
    список-ссылки на заголовки страницы.
  • Диаграммы — блок ```mermaid рендерится как диаграмма Mermaid
    (блок-схемы, sequence, C4-контекст и другие).
  • Доски — !board:<id-доски> вставляет одну из ваших досок: живое превью со
    ссылкой Открыть доску и кнопкой Рисовать здесь, открывающей канвас
    прямо в странице. Вставить → Доска открывает выбор с поиском и структурой
    папок, а Пустая доска создаёт чистую доску и вставляет её — сразу можно
    рисовать.
  • Фреймы — !iframe:<url> встраивает живую страницу прямо в документ:
    внешний статус-пейдж, self-hosted инструмент или same-origin страницу,
    например встроенный справочник API (!iframe:/swagger/...). Страница
    грузится в изолированном фрейме в браузере читателя и всегда актуальна —
    без копипасты. В диалоге Вставить HTML на панели редактора есть поле URL,
    которое вставит макрос за вас. Администраторы могут ограничить список
    разрешённых хостов переменной MOCKARTY_WIKI_IFRAME_ALLOWLIST — список
    хостов через запятую, либо none, чтобы полностью запретить внешние
    встройки (same-origin страницы продолжают работать).
  • Диаграммы draw.io — Вставка → draw.io открывает полноценный редактор
    диаграмм в диалоге; нажмите там Save — и готовая диаграмма появится на
    странице картинкой. Файл сохраняет исходник, так что диаграмму можно потом
    доредактировать в любом draw.io. Редактор — внешний сервис draw.io:
    администратор подключает его переменной MOCKARTY_DRAWIO_URL (self-hosted
    draw.io или публичный редактор, если у сервера есть интернет). Пока не
    подключено, пункт меню показывается приглушённым с подсказкой.
  • HTML-блоки — Вставка → HTML принимает произвольный HTML (со скриптами)
    и рендерит его в изолированном фрейме: интерактивные виджеты, визуализации,
    свои формы. Блок не может затронуть остальное приложение.
  • Дашборды — !dashboard:<id> вставляет живую панель виджет-дашборда.
  • Живые таблицы задач — !tasks:<фильтр> рендерит живую таблицу задач
    трекера по фильтру; !tasks:source=jira <запрос> берёт данные из Jira-
    интеграции, настроенной в Настройках. !cases:<фильтр> и !plans:<фильтр>
    делают то же для тест-кейсов и тест-планов.
  • Переменные страницы — {{page.title}}, {{page.version}},
    {{page.author}}, {{page.updated}}, {{date}} подставляются при просмотре.

Будьте в курсе: подписка, меншены, реакции

  • Следить (кнопка-колокольчик на странице) подписывает вас: каждое изменение
    придёт в колокольчик приложения, на почту и в подключённые каналы.
  • Меншен — напишите @логин коллеги в тексте страницы, и он получит
    уведомление при сохранении.
  • Реакции — быстрый эмодзи под заголовком; повторный клик убирает.
  • Лейблы — помечайте страницы (+ рядом с заголовком) и фильтруйте дерево
    чипами над ним.
  • Избранное и недавние — закладки на ежедневные страницы; оба списка живут
    вверху дерева.
  • Главная пространства — страница со slug home становится лендингом:
    открывается первой при заходе в Wiki.

Кто видит страницу: ограничения доступа

По умолчанию страницу видит и правит любой участник пространства имён. Чтобы
сузить круг, откройте Ограничения в меню страницы — там два поля: «Могут
просматривать» и «Могут редактировать» (логины или email через запятую).

Главное правило, которое легко понять неправильно: страница закрывается,
как только заполнено ХОТЬ ОДНО из полей. Незаполненное поле не означает
«разрешено всем» — оно означает «сюда никого не добавили».

Что заполнено Кто откроет страницу
оба поля пустые все участники пространства имён
только «Могут редактировать» только перечисленные — остальные страницу не увидят вовсе
только «Могут просматривать» только перечисленные (правка — автору и администраторам)
оба поля перечисленные в обоих

Поэтому, если нужно «читают все, правит команда», перечислите читателей в
«Могут просматривать» — иначе страница пропадёт из дерева у всех остальных.
Диалог предупредит об этом прямо при вводе.

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

Закрытая страница исчезает целиком: её нет в дереве, в поиске, в экспорте и по
прямой ссылке (ответ такой же, как для несуществующей страницы, — так её
существование не выдаёт себя). Дочерние страницы скрываются вместе с родителем.

Требования

Любую страницу wiki можно сделать требованием — спецификацией, которую нужно
отслеживать, не покидая Wiki. Требование — это обычная страница (то же дерево, тот
же редактор, та же история версий и права доступа) с дополнительными данными:
короткий ключ (REQ-1, REQ-2, …), тип (функциональное или
нефункциональное) и произвольный статус (по умолчанию draft).

Сделать требование можно тремя способами:

  • Из меню страницы — откройте меню действий ⋮ у любой страницы в дереве
    (или щёлкните правой кнопкой) и выберите Сделать требованием. Выберите тип
    и подтвердите — страница сохранит всё, что было, и получит ключ REQ-N.
  • Перетаскиванием — перетащите страницу (или всё выделение) на зону
    Требования над деревом. Откроется тот же выбор типа с кнопкой
    Переместить, и каждая перетащенная страница за один шаг станет требованием.
  • Из агента — инструмент wiki_page_convert помечает страницу требованием
    или возвращает обратно, так что ИИ-ассистент может сам превратить страницу-спеку
    в отслеживаемое требование.

У требования рядом с заголовком в дереве появляется цветной значок REQ-N, а
вверху страницы — плашка «тип · статус». Чтобы вернуть его в обычную страницу,
выберите Вернуть в страницу в том же меню — ключ снимется, а страница
останется прежней.

Только требования. Над деревом переключатель Все / Требования задаёт
охват дерева: выберите Требования — останутся только требования, а ведущие к
ним папки сохранятся, чтобы структура не рассыпалась; остальное скроется. Зона
Требования работает и как переключатель (клик — сфокусироваться, перетащить
страницу — сделать требованием) и показывает, сколько требований в пространстве.

Трейсабилити — а оно вообще проверено? Откройте требование, и панель
Трейсабилити покажет тест-кейсы, которые его проверяют, у каждого — последний
результат прогона, и один общий вердикт:

  • Проверено — хотя бы один покрывающий кейс прошёл и ни один не красный.
  • Падает — покрывающий кейс упал (красный побеждает зелёные, поэтому зелёный
    вердикт не покажется, пока известный тест падает).
  • Не запускалось / Нет кейсов — покрыто, но не запускалось, или ещё
    ничего не связано.

Кнопка Связать кейс ищет ваши тест-кейсы и привязывает те, что доказывают
требование (та же связь, что делает секция Документация в редакторе кейса —
видна с обеих сторон). Для требования с под-требованиями панель сворачивает всё
поддерево в один вердикт: родитель читается как Проверено, только когда он и всё
под ним проверено.

Секция Задачи в панели связывает требование с задачами и багами трекера —
нажмите Связать задачу, найдите и привяжите. Секция Доски / диаграммы
так же связывает страницу с досками (whiteboard) — нажмите Связать доску,
найдите и привяжите. Документация, требования, задачи, тест-кейсы и доски
связываются друг с другом: из требования видно стоящие за ним задачи, кейсы и
доски, а из задачи можно вернуться к требованиям и спекам, которые её упоминают.

Это не только для требований: на любой странице wiki кнопка Связи в
тулбаре открывает ту же панель — обычный runbook или дизайн-док тоже можно
связать с относящимися к нему тест-кейсами, задачами и досками.

Связь с тестами

  • Кнопка Связи показывает всё, что связано со страницей: где она упомянута
    в wiki и какие тест-кейсы и тест-планы её покрывают. Обратные связи
    создаются из редактора кейса / формы плана — там есть секция «Документация»,
    привязывающая кейс или план к странице-спецификации.
  • Обсуждения открываются на любой странице из боковой панели; к обсуждению
    страницы можно привязать Telegram-чат группы — бот хранит недавнюю
    историю чата, а команда /summarize публикует выжимку переписки в
    обсуждение, чтобы решения из мессенджера не терялись.
  • Комментарии живут внизу каждой страницы — это та же беседа, что и в
    обсуждении, но в виде ленты комментариев в стиле Confluence. Редактор
    поддерживает Markdown с панелью форматирования, вставку картинок и файлов,
    @-упоминания с автодополнением (упомянутый получает уведомление в
    колокольчик со ссылкой на страницу) и ответы: ответьте на комментарий — над
    ним появится цитата оригинала, а его автор получит уведомление об ответе.
    Записи встреч из звонка отображаются карточкой со встроенным плеером; если
    доступна транскрибация, расшифровка приходит отдельным комментарием.

Экспорт и синхронизация

  • PDF — печать любой страницы в PDF из браузера (страница рендерится в
    чистом print-макете).
  • ZIP пространства — кнопка экспорта в шапке дерева скачивает всё
    пространство ZIP-архивом markdown-файлов с сохранением дерева.
  • Git-синхронизация — подключите репозиторий в Настройках, и страницы
    синхронизируются с markdown-файлами в git: правьте в приложении или в своём
    редакторе — работают оба направления.

AI-помощник по написанию

Когда настроена языковая модель, писать помогают три кнопки:

  • Суммаризировать (режим просмотра) — краткая выжимка страницы.
  • Улучшить (режим редактирования) — переписывает текущий текст для ясности,
    сохраняя смысл, блоки кода и структуру; вы подтверждаете замену черновика.
  • Черновик (режим редактирования) — генерирует содержимое страницы по
    короткому запросу и добавляет его в редактор.

Ничего не сохраняется автоматически — результат AI попадает в редактор, а вы
решаете, что оставить. Если модель не настроена, кнопки вернут понятное
сообщение «недоступно».

Поиск

Страницы Wiki входят в глобальный поиск платформы: результаты ищутся по
заголовку и содержимому страницы. AI-агент тоже умеет искать по Wiki и
ссылаться на нужную страницу в ответах.

Импорт из Confluence, Notion или markdown

Кнопка Импорт в шапке дерева переносит существующую базу знаний:

  • Confluence — ZIP HTML-экспорта пространства;
  • Notion — ZIP экспорта «Markdown & CSV»;
  • Markdown — любой ZIP из .md/.markdown файлов в дереве папок.

Структура папок становится деревом страниц. Страницы создаются под открытой
страницей (или в корне); существующее не перезаписывается. Импортёр защищён от
слишком больших архивов.

Макросы Confluence переживают переезд. Импортёр переводит макросы
Confluence в родные блоки выше, а не сплющивает их в текст: панели
info/note/warning/tip становятся :::-панелями (заголовок сохраняется жирным),
код-блоки сохраняют язык и отступы как fenced-код, оглавление становится
[[TOC]], разворачиваемые секции — сворачиваемыми блоками, статус-плашки —
жирными метками [TAG], ключи Jira-задач остаются читаемыми как inline-код.
Ссылки и жирный/курсив сохраняются как markdown. Незнакомый макрос сохраняет
свой читаемый текст и помечается HTML-комментарием с именем исходного макроса —
такие места легко найти и доработать, ничего не теряется молча.

Включение Wiki

Wiki поставляется внутри модуля «Процессинг и коммуникации» — включается тем же переключением на уровне
пространства, что и остальные фичи этого семейства. Пока не включено, API вернёт
понятную ошибку с указанием на настройку.