type: index
aspect: format
title: "Стандарты форматов"
version: 1.0.0
date: 2026-02-19

Стандарты форматов

Правила форматирования документов, данных и кода платформы.

СОДЕРЖАНИЕ

Форматы документов

Документ	Описание	Статус
DOCUMENT.md	Типы документов (.md, .ai.md, .yaml, .credentials.md)	✅ Active
MARKDOWN.md	Стандарт Markdown (GFM + Pandoc + Custom)	✅ Active
FILE_TYPES.md	11 классов файлов и правила размещения	✅ Active

Форматы данных

Документ	Описание	Статус
data.md	YAML, JSON, CSV, Excel — выбор и конвертация	✅ Active
notifications.md	Формат уведомлений (Telegram, email, webhook)	✅ Active

Форматы кода

Документ	Описание	Статус
code.md	Стиль кода (Python, JavaScript, TypeScript, Bash)	✅ Active

БЫСТРЫЙ СТАРТ

Создаю новый документ

Проверить тип документа: DOCUMENT.md
Использовать Markdown стандарт: MARKDOWN.md
Добавить frontmatter:

---
type: standard|concept|theory|pattern|template
aspect: format|structure|lifecycle|process|policy|naming|typology|operation|guidance
title: "Название документа"
version: 1.0.0
date: YYYY-MM-DD
status: draft|active|deprecated
---

Работаю с данными

Выбрать формат: data.md — матрица YAML/JSON/CSV/Excel
Следовать правилам:
- Конфиги → YAML
- API/Логи → JSON
- Таблицы → CSV
- Обмен с бизнесом → Excel

Пишу код

Проверить стиль: code.md
Запустить форматтер:
- Python: black .
- JavaScript: prettier --write .
- Bash: shfmt -w script.sh

ИНСТРУМЕНТЫ

Форматирование

Формат	Инструмент	Установка
Python	Black	`pip install black`
JavaScript/TS	Prettier	`npm install -g prettier`
Bash	shfmt	`go install mvdan.cc/sh/v3/cmd/shfmt@latest`
Markdown	Prettier	`npm install -g prettier`

Валидация

Формат	Инструмент	Команда
YAML	yamllint	`yamllint file.yaml`
JSON	jq	`jq empty file.json`
Markdown	markdownlint	`markdownlint file.md`

Линтеры

Язык	Линтер	Команда
Python	ruff	`ruff check .`
JavaScript/TS	ESLint	`eslint .`
Bash	ShellCheck	`shellcheck script.sh`

ИЕРАРХИЯ СТАНДАРТОВ

5-format/
├── README.md              ← Этот файл
│
├── Документы
│   ├── DOCUMENT.md        ← Типы документов
│   ├── MARKDOWN.md        ← Стандарт Markdown
│   └── FILE_TYPES.md      ← Классы файлов
│
├── Данные
│   ├── data.md            ← YAML, JSON, CSV, Excel
│   └── notifications.md   ← Формат уведомлений
│
└── Код
    └── code.md            ← Python, JS, TS, Bash

СВЯЗАННЫЕ СТАНДАРТЫ

Аспект	Документ	Связь
Типология	7-typology/documents.md	Типы документов (ЧТО)
Именование	6-naming/files.md	Именование файлов (КАК НАЗЫВАТЬ)
Структура	1-structure/workspace.md	Где размещать файлы (ГДЕ)
Жизненный цикл	2-lifecycle/document.md	Жизненный цикл документов (КОГДА)

ПРИМЕНЕНИЕ

Создание документа

Выбрать тип: DOCUMENT.md → PROJECT.md, CLAUDE.md, README.md, etc.
Применить Markdown: MARKDOWN.md → frontmatter + GFM + Pandoc
Разместить: FILE_TYPES.md → $WORKSPACE или $DATASPACE

Работа с данными

Выбрать формат: data.md → YAML/JSON/CSV/Excel по матрице
Применить правила форматирования
Валидировать перед коммитом

Написание кода

Следовать стилю: code.md → PEP 8 / Airbnb / Google
Запустить форматтер: black / prettier / shfmt
Проверить линтером: ruff / eslint / shellcheck
Зафиксировать с типизацией

МИГРАЦИЯ

Добавить frontmatter к существующим .md

# Скрипт в architect/tools/md-migrate.sh
for file in **/*.md; do
  if ! head -n1 "$file" | grep -q '^---$'; then
    # Добавить frontmatter
    echo "Processing $file"
  fi
done

Форматировать существующий код

# Python
black .
ruff check --fix .

# JavaScript
prettier --write .
eslint --fix .

# Bash
find . -name "*.sh" -exec shfmt -w {} \;

CHANGELOG

2026-02-19 — v1.0.0

Создан README для 5-format/
6 стандартов форматов:
DOCUMENT.md (типы документов)
MARKDOWN.md (стандарт Markdown)
FILE_TYPES.md (классы файлов)
data.md (форматы данных)
notifications.md (уведомления)
code.md (стиль кода)

СТАТИСТИКА

Файлов в 5-format/: 7 (6 стандартов + 1 README)

Охват:
- ✅ Документы (3 стандарта)
- ✅ Данные (2 стандарта)
- ✅ Код (1 стандарт)

Статус: ФАЗА 1 завершена ✅

Версия: 1.0.0
Дата: 2026-02-19
Владелец: architect