Как обновлять docs¶
Статус: draft
Владелец: OpenClaw / Operations
Аудитория: internal
Чувствительность: public_internal
Быстрый маршрут¶
- Определить аудиторию: internal, legal или обе.
- Выбрать тип страницы: project page, runbook, FAQ, decision, legal instruction.
- Проверить Docs Quality Bar.
- Убрать клиентские данные, секреты, raw logs и персональные детали.
- Проверить сборку:
python -m mkdocs build --strict -f mkdocs.yml
python -m mkdocs build --strict -f mkdocs.legal.yml
Куда писать¶
| Материал | Source | Комментарий |
|---|---|---|
| Internal project/runbook/governance | docs-portal/ |
Полный рабочий слой команды |
| Legal-facing инструкция | docs-legal/ |
Без dev-runbooks и внутренней архитектуры |
| Черновик для обсуждения | PR/issue/Notion draft | Не source of truth |
| Raw notes, postmeet, security details | вне портала | Не публиковать в broad docs |
Definition of Done¶
- Есть статус, владелец, аудитория и чувствительность.
- Страница отвечает на конкретный вопрос или помогает выполнить действие.
- Есть проверка результата или критерий “когда эскалировать”.
- Все примеры синтетические или обезличенные.
- Legal build не ссылается на internal-only страницы.
- Поиск по странице должен находить ее по 2-3 естественным запросам.