architect/standards/3-process/process-documentation.md

type: standard
aspect: process
title: "Процесс: Документирование"
version: 1.0.0
date: 2026-02-19
status: active


Процесс: Документирование

Версия: 1.0.0
Дата: 2025-11-30
Уровень: У1 (Правила)


ПО 9 ВОПРОСАМ

Вопрос Ответ
ПОЧЕМУ? Знания теряются без фиксации
ЗАЧЕМ? Сохранить контекст для будущих сессий
ЧТО? Markdown документы
КТО? Архитектор (методология) + все агенты (свои области)
КАК? См. ниже
ЧЕМ? Markdown, YAML
ГДЕ? Рядом с кодом или в architect/
КОГДА? При изменениях + по запросу
СКОЛЬКО? Минимум необходимого

ТИПЫ ДОКУМЕНТОВ

УРОВНИ:
├── У0 (Идея)      — theory/, concept/     — LOCKED
├── У1 (Стандарты) — standards/            — Редко меняется
├── У2 (Паттерны)  — patterns/             — По мере накопления
├── У3 (Шаблоны)   — templates/            — Готовые заготовки
└── У4 (Инстансы)  — {project}/            — Конкретные реализации

ФОРМАТЫ:
├── UPPER_CASE.md    — Документы
├── kebab-case.ai.md — AI-агенты
├── index.yaml       — Индексы
└── README.md        — Точки входа

АЛГОРИТМ (КАК?)

1. ТРИГГЕР
   ├── Новая сущность создана
   ├── Существенное изменение
   └── Запрос оператора

2. ОПРЕДЕЛИТЬ ТИП
   ├── Уровень (У0-У4)
   ├── Формат (md, yaml)
   └── Место (где создать)

3. СОЗДАТЬ/ОБНОВИТЬ
   ├── Использовать шаблон
   ├── Заполнить обязательные поля
   └── Добавить ссылки

4. ПРОВЕРИТЬ
   ├── Версия указана
   ├── Ссылки работают
   └── Нет дублирования

5. ИНТЕГРИРОВАТЬ
   ├── Добавить в индекс
   ├── Обновить ссылки в других документах
   └── Commit

ПРАВИЛА

Когда документировать

Ситуация Действие
Новый проект index.yaml + README.md
Новая инфра INFRA.yaml
Архитектурное решение ADR в design/
Изменение API Обновить README
Баг и решение Не документировать (git history)

Когда НЕ документировать

Формат

# НАЗВАНИЕ

**Версия:** X.Y.Z
**Дата:** YYYY-MM-DD

---

## СЕКЦИЯ 1

...

---

**Версия:** X.Y.Z

ВЕРСИОНИРОВАНИЕ

Изменение Версия
Исправление опечатки X.Y.Z+1
Добавление секции X.Y+1.0
Изменение структуры X+1.0.0

ССЫЛКИ

Относительные пути

[Документ](../other/DOC.md)
[Секция](./DOC.md#секция)

Проверка ссылок

# Найти битые ссылки
grep -r "\](" architect/ | grep "\.md" | while read line; do
  # проверить существование файла
done

Версия: 1.0.0