Версия: 1.0.0
Дата: 2025-11-28
Уровень: У1 (Правила)
Вытекает из: ../../PLATFORM.md → DRY, KISS
Единые правила оформления документов платформы.
| Тип | Расширение | Где | Пример |
|---|---|---|---|
| Документ | .md | architect/ | WORKSPACE.md |
| AI-документ | .ai.md | system/ | architect.ai.md |
| Конфиг | .yaml | везде | config.yaml |
| Код | .py | solution/ | app.py |
# Название документа
**Версия:** X.Y.Z
**Дата:** YYYY-MM-DD
**Уровень:** У0-У4 (Название)
**Вытекает из:** [путь](путь) → Что именно
---
## НАЗНАЧЕНИЕ
Одно предложение: что делает этот документ.
---
## [ОСНОВНОЕ СОДЕРЖАНИЕ]
Содержимое по теме документа.
---
**Версия:** X.Y.Z
| Тип документа | Структура |
|---|---|
| Теория | Определение → Объяснение → Примеры → Следующий шаг |
| Концепция | По 8 аспектам (ЗАЧЕМ? ЧТО? КАК? ...) |
| Стандарт | Назначение → Правила → Примеры |
| Роль | По 8 аспектам + ПРАВИЛА (можно/нельзя) |
# Название роли
**Версия:** X.Y.Z
**Дата:** YYYY-MM-DD
**Тип:** ИИ-агент
**Вытекает из:** [standards/roles/xxx.md](путь)
---
## РОЛЬ
Одно предложение: кто ты.
---
## ЗОНА ОТВЕТСТВЕННОСТИ
Что делаешь / не делаешь.
---
## АЛГОРИТМ
Как принимаешь решения.
---
## ПРАВИЛА
### МОЖНО
- ...
### НЕЛЬЗЯ
- ...
---
# H1 — только название документа (один раз)
## H2 — основные секции
### H3 — подсекции
Маркированный:
- Пункт 1
- Пункт 2
Нумерованный:
1. Шаг 1
2. Шаг 2
| Колонка 1 | Колонка 2 |
|-----------|-----------|
| Значение | Значение |
Инлайн: `код`
Блок:
```язык
код
```
Внутренняя: [текст](относительный/путь.md)
Внешняя: [текст](https://url)
vMAJOR.MINOR.PATCH
MAJOR — несовместимые изменения
MINOR — новый функционал
PATCH — исправления
**Версия:** X.Y.Z**Версия:** X.Y.Z| Изменение | Версия |
|---|---|
| Исправление опечатки | PATCH +1 |
| Добавление секции | MINOR +1 |
| Изменение структуры | MAJOR +1 |
Документация: Русский
Комментарии: Русский
Названия файлов: English (UPPER_CASE.md или kebab-case.md)
Код: English
Git commits: English
Версия: 1.0.0