Протофрейм — шаблон с именованными слотами; конкретизация — заполнение слотов значениями. В документации это шаблоны типов записей: у runbook'а — цель, предусловия, шаги, откат; у регламента — название, владелец, этапы. Единые шаблоны упрощают поиск, RAG и онбординг.
В репозитории документов часто используют YAML-frontmatter в .md: поля title, owner, tags — их потом читает пайплайн индексации.
Зачем шаблоны
Без шаблона каждый пишет по-своему: один runbook — списком, другой — сплошным текстом. Поиск и извлечение структуры усложняются. Шаблон задаёт обязательные поля и формат; все runbook'и выглядят единообразно. RAG получает стабильную структуру и лучше находит релевантные блоки (например, «шаги» или «откат»).
Типы записей как протофреймы
Регламент: название, цель, владелец, этапы, ссылки. Runbook: симптомы/триггер, предусловия, шаги по порядку, откат, эскалация. Справочник: команда или конфиг, описание, пример. Каждый тип — свой набор слотов. В Confluence/Notion это шаблоны страниц; в Markdown — заголовки и блоки с фиксированными именами. При индексации в RAG метаданные (тип, владелец) можно выносить в отдельные поля для фильтрации.
Практика
Ввести 3–5 типов записей и один шаблон на тип. Обучить команду заполнять только по шаблону. При добавлении в базу знаний парсить структуру и сохранять метаданные. Чат по архиву тогда может отвечать «покажи шаги отката» или «кто владелец регламента X» — за счёт единообразия полей.
Практики применения
- Шаблоны и протофреймы для типов записей — единый формат; упрощает каталогизацию и RAG.
- Ведите типы записей в базе знаний — так чат и люди дают согласованные ответы.
Практика с библиотекой Adminica
Тема «Структурированные шаблоны в документации» лучше всего раскрывается на ваших материалах: кураторская библиотека плюс документы профиля и org-библиотека (если подключена). Задайте в чате конкретный вопрос, проверьте блок источников и при необходимости уточните формулировку — так RAG даёт воспроизводимый ответ, а не общий пересказ.
Короткий чек-лист
- Один главный вопрос за сообщение; контекст — во вложении или ссылке на запись архива.
- После обновления документов дождитесь индексации, прежде чем сравнивать ответы.
- Для командных регламентов храните master-копию в согласованном разделе базы знаний.
Тарифы и on-prem зависят от контура; начните с чата на своих данных и оцените качество по цитатам, а не только по гладкости текста.
Итог: структурированные шаблоны — протофреймы в действии. Runbook, регламент, справочник с фиксированными полями улучшают поиск и качество RAG. Начните с трёх типов и одного шаблона на каждый.