architect/arh/standards/before-reform-2026-02-19/DOCUMENT.md

type: standard
title: "Стандарт документа платформы"
status: active
version: 1.0.0
date: 2026-02-17
owner: architect

Стандарт документа платформы

Формат файла

Все документы платформы — файлы .md (Markdown).

architect/standards/BACKUP.md   ← правильно
architect/standards/backup.docx ← запрещено

Frontmatter

Каждый документ начинается с блока метаданных между ---.

Обязательные поля

---
type: standard        # тип документа (см. [[TYPES]])
title: "Название"     # заголовок документа
status: active        # статус (см. ниже)
version: 1.0.0        # версия (SemVer)
date: 2026-02-17      # дата создания или последнего изменения
---

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

---
owner: architect      # кто отвечает за документ
review_date: 2026-08-17  # когда пересмотреть
tags: [infrastructure, security]  # теги
parent: architect/concept/PLATFORM.md  # родительский документ
related:
  - architect/standards/DEPLOYMENT.md
  - architect/standards/BACKUP.md
---

Статусы

Статус Значение
draft Черновик — в работе, не применять
active Актуальный — применяется
outdated Устарел — есть новая версия
archived В архиве — не применяется

Структура документа

Обязательные секции

---
[frontmatter]
---

# Название документа          ← H1, одно на документ

## Определение                ← что это такое (одна фраза)

[основной контент]

---

## Связи                      ← ссылки на связанные документы

Именование секций

Секции называются по-русски с заглавной буквы — они становятся якорями для [[WikiLinks]]:

## Зона ответственности
## Правила
## Примеры
## Связи

Ссылка на секцию: [[DOCUMENT#Правила]]

Ссылки и вставки

Ссылка на другой документ

Подробнее: [[standards/BACKUP]]

→ читатель переходит в другой документ

Вставка секции из другого документа

![[standards/BACKUP#Правила]]

→ содержимое секции "Правила" из BACKUP.md вставляется сюда

Внешняя ссылка

[Название](https://example.com)

Именование файлов

Правило Пример
Заглавные буквы BACKUP.md
Слова через _ PROJECT_STRUCTURE.md
Без пробелов ❌ my document.md
Английский BACKUP.md не РЕЗЕРВ.md

Типы документов

Полный список типов: [[TYPES]]

Тип Где лежит Назначение
theory architect/theory/ Теория (LOCKED)
concept architect/concept/ Концепция платформы
standard architect/standards/ Правила и стандарты
process architect/standards/processes/ Процессы и алгоритмы
pattern architect/patterns/ Типовые решения
template architect/templates/ Шаблоны документов
research architect/research/ Исследования
decision architect/decisions/ Архитектурные решения (ADR)

Пример документа

---
type: standard
title: "Правила резервного копирования"
status: active
version: 1.2.0
date: 2026-02-17
owner: architect
review_date: 2026-08-17
related:
  - architect/standards/processes/DEPLOYMENT.md
---

# Правила резервного копирования

## Определение

Процесс создания резервных копий данных и кода платформы.

## Правила

- Бэкап запускается ежедневно в 03:00
- Хранится 30 дней
- Проверяется еженедельно

## Связи

- [[processes/DEPLOYMENT]] — деплой после бэкапа
- [[processes/RECOVERY]] — восстановление из бэкапа

Связи