Skip to content

how-to-use.md

Latest commit

 

History

History
53 lines (43 loc) · 5.81 KB

how-to-use.md

File metadata and controls

53 lines (43 loc) · 5.81 KB
Raw
title Как пользоваться базой знаний
sidebar_label Как пользоваться
description Ориентация по разделам книги, принципы страниц под поиск и RAG, соглашения по frontmatter и ссылкам.
category intro
tags
intro
navigation
rag
last_updated 2026-05-11 00:00:00 UTC
source_url
content_type reference

Как пользоваться базой знаний

Ниже — как быстро найти нужный тип материала и как устроены отдельные страницы. Общие цели проекта и аудитория описаны на странице «О базе знаний». Типовые маршруты «термин → данные → форма» — на странице Карта данных.

Ориентация по разделам

Левое меню повторяет каноническую структуру базы знаний (v2). Типичные маршруты:

Раздел Зачем открывать Точка входа
Введение Контекст, обзор бюджета, ключевые законы, история изменений Введение, О базе знаний
Глоссарий Определения терминов и связи между понятиями Глоссарий
Организации Роли владельцев данных и операторов учёта Организации
Информационные системы Государственные и гражданские ИС, точки входа в данные Информационные системы
Бюджетная система Уровни бюджетов, цикл, доходы и расходы в целом Бюджетная система
Бюджетная классификация Коды КБК, КОСГУ, целевые статьи и справочники Бюджетная классификация
Источники данных Открытые наборы и порталы (федеральные, региональные, международные, гражданские) Источники данных
Инструкции (How-to) Практика доступа, анализа и автоматизации How-to
Нормативная база Законы и подзаконные акты с привязкой к теме открытых финансов Нормативная база
Бюджетная отчётность Формы и виды отчётности (карточки форм) Бюджетная отчётность
Справочники Индексы, аббревиатуры, коды, ссылки и вспомогательные материалы Справочники

Главная страница книги — стартовый документ.

Принципы контента

  • Один файл — одна основная сущность (термин, организация, источник, форма отчётности, информационная система и т.п.).
  • Семантические заголовки ## и ниже задают структуру текста; их удобно использовать как якоря при поиске и при работе с RAG.
  • Frontmatter в начале файла (title, description, tags, при необходимости source_url, last_updated) поддерживает навигацию и переиспользование материала. Рекомендуемые значения второго тега — в таксономии тегов.
  • Перекрёстные ссылки между разделами в карточках лучше указывать каноническими путями от корня сайта (/glossary/kbk, /data-sources/federal/...), чтобы ссылки не ломались при переносе текста и были однозначны для индексации.
  • Там, где это уместно, в конце страниц добавлены вопросы и ответы или блоки «частые вопросы» по шаблонам карточек разделов.

Перекрёстные ссылки

  • В текстах карточек (глоссарий, источники, организации, ИС, отчётность, нормативные документы) предпочтительны канонические URL от корня сайта: /glossary/..., /data-sources/..., /legal/... — как в шаблонах и в AGENTS.md. Так ссылки остаются предсказуемыми при выгрузке, зеркалировании и индексации для RAG.
  • Относительные ссылки к соседним файлам в одной папке (./...) оставляйте там, где важна переносимость каталога без привязки к опубликованному URL.
  • Соглашения для участников и проверка сборкой — в CONTRIBUTING.md в корне репозитория.