architect/standards/arch-document-system.md

type: standard
layer: arch
object: document
aspect: system
form: text
title: "Документная система платформы"
status: active
version: 1.1.0
date: 2026-04-15
knowledge_level: У1
parent: arch-document-format.md


Документная система платформы

Стандарт описывает документную систему платформы от атома (поле) до целого: поле → документ → форма → тип → уровень → класс → служебные файлы → жизненный цикл → именование.


1. ПОЛЕ

Поле — минимальная единица описания. Одна запись ключ: значение в frontmatter документа.

type:   standard
status: active
layer:  arch

Каждое поле отвечает на один вопрос о документе. Поля образуют frontmatter — метаданные файла. Документ без frontmatter — не документ платформы, а произвольный текст.

Обязательные поля (минимум для любого документа):

Поле Вопрос Пример
type Что это за документ? standard
title Как называется? "Структура Workspace"
status Действует ли сейчас? active
date Когда создан / изменён? 2026-04-11

2. ДОКУМЕНТ

Документ — один .md файл. Минимальная единица хранения знаний платформы.

Состоит из двух частей:

frontmatter   — метаданные (поля §1)
содержание    — H1 заголовок + разделы H2/H3 + текст

Три правила документа:

  1. Один документ = одна тема. Если AI иногда нужна только часть — значит внутри несколько тем → разделить.
  2. Один H1 — совпадает с полем title во frontmatter.
  3. Самодостаточность — документ понятен без знания папки, в которой лежит.

Размер:

Один документ = одна тема. Размер — следствие, не цель.

Разделить  — если AI иногда нужна только часть
Слить      — если два документа всегда нужны вместе

🟢 < 500 строк   — норма
🟡 500–800       — проверь: нет ли нескольких тем внутри
🔴 > 800         — разделить

3. ФОРМА

Форма — сущность документа: как устроено его содержание.

Форма Что это Пример
text Нарратив, объяснение, рассуждение концепция, руководство
table Справочник, список с атрибутами белый список расширений
schema Диаграмма, структура, граф схема 6 слоёв
code Готовый код, конфиг, шаблон docker-compose, скрипт

Форма — отдельная от типа координата. Один тип может иметь любую форму:

standard + table  = справочная таблица
standard + text   = описание правил
concept  + schema = визуальная модель
pattern  + code   = готовый шаблон кода

Хранится в frontmatter:

form: table

4. ТИП

Тип определяет назначение документа — зачем он существует.

Знания — постоянные, живут в arch/:

Тип Назначение Уровень
concept Как мы понимаем предмет У0
standard Правила: как должно быть сделано У1
pattern Типовое решение из опыта У2
template Заготовка для заполнения У4

Рабочие — процессные, живут в project/:

Тип Назначение
plan Что и когда делаем
instruction Как делать шаг за шагом
ticket Задача / баг / долг
decision ADR — почему решили именно так
research Активное изучение внешних систем
analysis Выводы, закономерности
practice Накопленный опыт, статистика

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


5. УРОВЕНЬ

Уровень показывает место документа в иерархии знаний: от принципов до готовых артефактов.

Уровень Тип Что описывает Время жизни
У0 concept Принципы, видение, базовые понятия Годы
У1 standard Правила: как должно быть сделано Месяцы
У2 pattern Типовое решение из опыта Месяцы
У3 instruction Как выполнить конкретное действие Недели
У4 template / артефакт Готовая вещь: код, шаблон, конфиг По релизам

Правило каскада: нижний уровень не может противоречить верхнему.

У0 → У1 → У2 → У3 → У4

Изменение У1 без обновления зависимых У2–У4 — запрещено.
Изменение У0 — требует пересмотра всей цепочки вниз.


6. КЛАСС ФАЙЛА

Класс определяет для кого файл существует.

Класс Для кого Примеры
Служебный Системы: git, AI, файловая система CLAUDE.md, AI.md, README.md, .gitignore
Содержательный Люди и AI-агенты концепции, стандарты, паттерны, тикеты
Технический Инструменты: docker, python, node код, конфигурация, данные

Служебные файлы — особый статус:
- Именуются UPPERCASE или по специальной формуле
- Формула [layer]-[object]-[aspect].(тип).md к ним не применяется
- Создаются в строго определённых местах (см. §7)

Содержательные файлы — основной массив документов платформы:
- Именуются по формуле [layer]-[object]-[aspect].(тип).md
- Хранятся в arch/, project/, domains/

Технические файлы — не документы:
- Не имеют frontmatter
- Управляются инструментами, не людьми вручную


7. СЛУЖЕБНЫЕ ФАЙЛЫ

В каждом важном узле платформы — четыре файла навигации:

AI.md       = контекст для любого AI (лаконично, без объяснений)
CLAUDE.md   = AI.md целиком + Claude Code специфичное
README.md   = AI.md целиком + комментарии для людей
INDEX.md    = каталог всего содержимого узла (RAG-навигатор)

Пишутся в порядке: AI.md → CLAUDE.md → README.md → INDEX.md.

INDEX.md содержит все подпапки с описаниями — включая те, что ещё не созданы. AI понимает структуру до появления содержимого.

Где создавать четвёрку:

Корень $WORKSPACE                            
6 компонентов (architect/, projector/...)    
Корень проекта (org/lideravto/)              
Модуль с ролью (@arch.module/)                + role.ai.md
Вложенные папки (src/, scripts/)             

Роли — отдельные файлы определения агента:

architect.ai.md
projector.ai.md

Не путать с AI.md папки — это разные вещи.


8. ЖИЗНЕННЫЙ ЦИКЛ

Каждый документ проходит стадии от создания до архива.

Основные статусы:

draft → active → deprecated → archived
Статус Что означает
draft Пишется, не действует
active Действует, является истиной
deprecated Устарело, есть замена — ссылка обязательна
archived Убран в архив, не используется

Опциональные:

Статус Что означает
suspended Заморожено временно, вернётся
cancelled Отменено, не будет завершено

Хранится в frontmatter:

status: active

Документ со статусом deprecated должен содержать ссылку на замену:

replaced_by: arch-documents-v2.md

9. ИМЕНОВАНИЕ ФАЙЛОВ

Формула для содержательных файлов:

[layer]-[object]-[aspect].(тип).md
Часть Обязательность Описание
layer да Слой платформы: arch / project / domain / infra / system / service
object да Что описываем: document, workspace, file, project
aspect да Одна из 10 категорий (см. ниже)
(тип) нет Статус файла: .draft .tpl .ai .spec

10 аспект-категорий:

structure / format / naming / lifecycle / policy
process / operation / guidance / system / protocol

Читается слева направо: откуда → что → о чём

arch-document-format.md       ← arch / document / format
arch-workspace-structure.md   ← arch / workspace / structure
project-lideravto-process.md  ← project / lideravto / process

Служебные файлы — UPPERCASE, формула не применяется:

CLAUDE.md / AI.md / README.md / INDEX.md
architect.ai.md / projector.ai.md

СВЯЗАННЫЕ ДОКУМЕНТЫ

Родитель:
- arch-document-format.md — физическое оформление .md файла

Прямые потомки (child):
- arch-class-system.md — классовая система платформы
- arch-document-linking.md — операция СВЯЗЫВАНИЕ
- arch-intake-operation.md — операция РАЗБОР
- arch-rebuild-operation.md — операция ПЕРЕСБОРКА