PROJECT_DOCUMENTS — Документы проекта

Версия: 1.0.0
Дата: 2026-03-07

1. Зачем этот документ

Отвечает на один вопрос: какие файлы должны быть в проекте данного типа?

Использовать совместно с:
- PROJECT_STANDARD.md — правила именования и структуры
- PROJECT_TYPOLOGY.md — как определить тип проекта

2. Три категории документов

ОБЯЗАТЕЛЬНЫЕ   — без них проект не считается проектом
ТИПОВЫЕ        — обязательны для данного класса проекта
ОПЦИОНАЛЬНЫЕ   — добавляются при необходимости

3. Обязательные для любого проекта (BaseProject)

Эти файлы должны быть в корне каждого проекта без исключений:

Файл	Назначение	Кто читает
`INDEX.md`	Навигация: что где лежит, ссылки на всё	Человек + AI
`AI.md`	Контекст проекта для любого AI (нейтральный)	Любой AI
`CLAUDE.md`	Инструкции для Claude (из AI.md + специфика)	Claude
`STATUS.md`	Текущая стадия, что делаем, что заблокировано	Человек + AI
`LOG.md`	История решений (только пополняется)	Человек + AI
`arh/`	Папка архива устаревшего	—

Правило минимума: Если уровень простой — только CLAUDE.md (без AI.md).
Если нужна совместимость с другими AI → оба файла.

4. Матрица: тип проекта → документы

OrgProject (org)

Организация, холдинг, группа компаний.

ОБЯЗАТЕЛЬНЫЕ (base):  INDEX, AI, CLAUDE, STATUS, LOG, arh/
ТИПОВЫЕ:
  STRUCTURE.md        ← кто в организации, роли, ответственности
  PROCESSES.md        ← как работаем, регламенты
ОПЦИОНАЛЬНЫЕ:
  GLOSSARY.md         ← термины организации

BizProject (biz)

Коммерческое направление, канал продаж, продукт.

ОБЯЗАТЕЛЬНЫЕ (base):  INDEX, AI, CLAUDE, STATUS, LOG, arh/
ТИПОВЫЕ:
  BRIEF.md            ← зачем проект, для кого, контекст
  CONCEPT.md          ← что делаем, ценность
  REQUIREMENTS.md     ← что должно быть реализовано
ОПЦИОНАЛЬНЫЕ:
  GLOSSARY.md         ← термины домена
  DESIGN.md           ← если есть IT-часть

ITProject (it)

Сайт, приложение, сервис, инструмент, интеграция.

ОБЯЗАТЕЛЬНЫЕ (base):  INDEX, AI, CLAUDE, STATUS, LOG, arh/
ТИПОВЫЕ:
  DESIGN.md           ← архитектура: как устроено, схемы, решения
  GUIDE.md            ← как делать (или GUIDE-тема.md для подтем)
  README.md           ← как запустить (только для кода)
  LAUNCH.md           ← как задеплоить на production
ОПЦИОНАЛЬНЫЕ:
  GLOSSARY.md         ← специфичные термины
  BRIEF.md            ← если проект имеет бизнес-контекст

Подтипы IT:

Подтип	Обязательные типовые	Специфика
`site`	DESIGN, README, LAUNCH	+ GUIDE-import.md, GUIDE-catalog.md и т.п.
`app`	DESIGN, README, LAUNCH	+ DESIGN-api.md, DESIGN-db.md
`mobile`	DESIGN, README, LAUNCH	+ GUIDE-release.md
`bot`	DESIGN, README	—
`api`	DESIGN, README	+ GUIDE-endpoints.md
`integration`	DESIGN, GUIDE	—
`data`	DESIGN, GUIDE	+ GUIDE-pipeline.md
`infra`	DESIGN, LAUNCH	—
`tool`	README	минимум

Module (module / script)

Единица кода без жизненного цикла.

ЕДИНСТВЕННЫЙ ФАЙЛ:
  README.md           ← как запустить, зависимости, API

Модуль НЕ имеет: STATUS.md, LOG.md, AI.md. Только README.

OpsProject (ops)

Операционное направление: снабжение, склад, производство.

ОБЯЗАТЕЛЬНЫЕ (base):  INDEX, AI, CLAUDE, STATUS, LOG, arh/
ТИПОВЫЕ:
  BRIEF.md            ← что за операция, зачем
  PROCESSES.md        ← как выполняется, регламент
  GUIDE.md            ← пошаговые инструкции
ОПЦИОНАЛЬНЫЕ:
  REQUIREMENTS.md     ← требования к процессу

HRProject (hr)

Найм, обучение, развитие персонала.

ОБЯЗАТЕЛЬНЫЕ (base):  INDEX, CLAUDE, STATUS, LOG, arh/
ТИПОВЫЕ:
  BRIEF.md            ← задача найма / обучения
  REQUIREMENTS.md     ← требования к кандидату / курсу
  GUIDE.md            ← процесс
ОПЦИОНАЛЬНЫЕ:
  CONCEPT.md          ← если это большая инициатива

FinProject (fin)

Бюджет, аудит, отчётность, инвестиция.

ОБЯЗАТЕЛЬНЫЕ (base):  INDEX, CLAUDE, STATUS, LOG, arh/
ТИПОВЫЕ:
  BRIEF.md            ← что за финансовая задача
  REQUIREMENTS.md     ← что нужно получить
  GUIDE.md            ← методология, алгоритм
ОПЦИОНАЛЬНЫЕ:
  DESIGN.md           ← если есть автоматизация

MktProject (mkt)

Маркетинг: бренд, кампании, SEO, контент.

ОБЯЗАТЕЛЬНЫЕ (base):  INDEX, CLAUDE, STATUS, LOG, arh/
ТИПОВЫЕ:
  BRIEF.md            ← задача, аудитория, цель кампании
  CONCEPT.md          ← идея, позиционирование
  REQUIREMENTS.md     ← что нужно создать
ОПЦИОНАЛЬНЫЕ:
  GUIDE.md            ← как выполнять (контент-план, SEO-гайд)
  GLOSSARY.md         ← термины ниши

RDProject (rd)

Исследования, прототипы, R&D.

ОБЯЗАТЕЛЬНЫЕ (base):  INDEX, CLAUDE, STATUS, LOG, arh/
ТИПОВЫЕ:
  BRIEF.md            ← гипотеза, вопрос исследования
  DESIGN.md           ← методология исследования
  GUIDE.md            ← как проводим, этапы
ОПЦИОНАЛЬНЫЕ:
  CONCEPT.md          ← если есть продуктовая идея

PhysProject (phys)

Строительство, оборудование, мероприятия.

ОБЯЗАТЕЛЬНЫЕ (base):  INDEX, CLAUDE, STATUS, LOG, arh/
ТИПОВЫЕ:
  BRIEF.md            ← что строим / закупаем / проводим
  REQUIREMENTS.md     ← технические требования
  GUIDE.md            ← этапы, подрядчики, чеклист
ОПЦИОНАЛЬНЫЕ:
  DESIGN.md           ← проект, схема, план
  LAUNCH.md           ← сдача, ввод в эксплуатацию

5. Сводная таблица

Файл	org	biz	it	ops	hr	fin	mkt	rd	phys	module
`INDEX.md`	✅	✅	✅	✅	✅	✅	✅	✅	✅	—
`AI.md`	✅	✅	✅	✅	○	○	○	✅	○	—
`CLAUDE.md`	✅	✅	✅	✅	✅	✅	✅	✅	✅	—
`STATUS.md`	✅	✅	✅	✅	✅	✅	✅	✅	✅	—
`LOG.md`	✅	✅	✅	✅	✅	✅	✅	✅	✅	—
`BRIEF.md`	—	✅	—	✅	✅	✅	✅	✅	✅	—
`CONCEPT.md`	—	✅	—	—	—	—	✅	○	—	—
`REQUIREMENTS.md`	—	✅	—	○	✅	✅	✅	—	✅	—
`STRUCTURE.md`	✅	—	—	—	—	—	—	—	—	—
`PROCESSES.md`	✅	—	—	✅	—	—	—	—	—	—
`DESIGN.md`	—	—	✅	—	—	—	—	✅	○	—
`GUIDE.md`	—	—	✅	✅	✅	✅	○	✅	✅	—
`README.md`	—	—	✅	—	—	—	—	—	—	✅
`LAUNCH.md`	—	—	✅	—	—	—	—	—	○	—
`GLOSSARY.md`	○	○	○	—	—	—	○	—	—	—

✅ — обязательный для типа ○ — опциональный — — не применяется

6. Жизненный цикл документа

DRAFT    → черновик, в работе
ACTIVE   → актуальный, используется
FROZEN   → завершён, не меняется (пометить # FROZEN вверху)
ARCHIVED → перемещён в arh/ (хранится 1 стадию проекта)
DELETED  → после 1 стадии в arh/ — удаляется

Правила:
- STATUS.md — всегда ACTIVE, обновляется при каждом изменении
- LOG.md — только пополняется, никогда не редактируется
- BRIEF.md / CONCEPT.md — FROZEN после утверждения
- DESIGN.md — ACTIVE во время разработки, FROZEN после сдачи

7. Расширение документов

Когда документ вырастает — три формы по правилу из PROJECT_STANDARD.md:

DESIGN.md              ← эталон (резюме + ссылки)
DESIGN-catalog.md      ← расширение темы "каталог"
DESIGN-api.md          ← расширение темы "api"
DESIGN/                ← папка с деталями (схемы, таблицы, CSV)
  └── schema.png
  └── taxonomy.csv

Правило: если есть DESIGN-catalog.md — обязан существовать DESIGN.md.

8. Навигация в документах

Каждый документ (кроме INDEX.md) содержит:

[← Назад в оглавление](INDEX.md)       ← верхняя строка

{содержимое}

[← Назад в оглавление](INDEX.md)       ← нижняя строка

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

Тип ссылки	Формат	Пример
Внутри проекта	Относительная	`[DESIGN.md](DESIGN.md)`
Родительский проект	Относительная вверх	`[← Родитель](../INDEX.md)`
Соседний проект	Только через INDEX.md	`[ProektA](../prjA/INDEX.md)`
Внешний ресурс	Абсолютная http	`[Docs](http://docs.0kt.ru/...)`

Принцип изоляции

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

✅ Правильно:   [Каталог](../biz-catalog/INDEX.md)
❌ Неправильно: [API каталога](../biz-catalog/DESIGN-api.md)

Исключение: родительский проект может ссылаться на любые документы дочернего.

Чеклист документации проекта

Структура:
- [ ] INDEX.md существует и содержит все актуальные файлы
- [ ] STATUS.md содержит стадию и следующий шаг
- [ ] LOG.md содержит хотя бы одну запись
- [ ] arh/ папка создана

Навигация:
- [ ] Каждый документ содержит [← Назад в оглавление](INDEX.md) сверху и снизу
- [ ] Все ссылки внутри проекта — относительные
- [ ] Ссылки на соседние проекты ведут только на их INDEX.md

Содержимое:
- [ ] AI.md заполнен (не заглушка с {placeholder})
- [ ] Обязательные файлы по типу присутствуют (матрица, раздел 5)
- [ ] Устаревшие файлы перемещены в arh/

9. Алгоритм для AI: проверить документы проекта

1. Определить тип проекта (из AI.md поле type:)
2. Взять список обязательных из матрицы (раздел 5)
3. Для каждого обязательного файла:
   - Существует? → проверить содержимое
   - Отсутствует? → создать по шаблону из architect/templates/
4. Для каждого существующего файла:
   - ACTIVE или FROZEN? → оставить
   - Устарел? → предложить в arh/
   - Дублирует другой? → объединить
5. Обновить INDEX.md — добавить все актуальные файлы
6. Обновить STATUS.md — зафиксировать текущее состояние

Связи

PROJECT_STANDARD.md — правила структуры и именования
PROJECT_TYPOLOGY.md — типология (как определить тип)
PROJECT_PROCESSES.md — как создавать и вести проект
architect/templates/ — готовые шаблоны для каждого типа

Обновлено: 2026-03-07