Главная

Документация PlanForge

Актуально на: 2026-07-23

Единая точка входа в командную документацию. Всё живёт в репозитории (docs-as-code): правки идут через git/PR, ревьюятся как код и не расходятся с реальностью.

Не знаешь, как внести правку? → CONTRIBUTING-docs.md — три способа по уровню (разраб / аналитик / совсем не про git).

Куда идти

Ты…Тебе сюда
Аналитик / продакт — «зачем и что»product/ — vision, определение продукта, бизнес-модель, спецификация
Разработчик — «как устроено»engineering/ — запуск, модель данных, соглашения, производительность
Общий язык предметной областиdomain/ — структура бизнес-плана, модули, описания страниц, глоссарий
Деплой / сервер / эксплуатацияops/
«Почему так решили»decisions/ — ADR, короткие записи об архитектурных решениях
Планы и карта задачroadmap.md

Структура

docs/
  product/            продуктово-стратегический слой (аудитория: аналитики)
  engineering/        инженерный слой (аудитория: разработчики)
    design/           дизайн-хендофы и скриншоты
  domain/             общий язык — где product и engineering встречаются
    glossary.md       ⭐ единый словарь терминов
    business-plan/    структура БП (Project Expert и пр.)
    modules/          маркетплейс, фидбек, AI-ассистент…
    page-descriptions/ описание каждой страницы business_model
  ops/                деплой, сервер, раннбуки
  decisions/          ADR — журнал архитектурных решений
  archive/            снимки состояния и завершённые планы (только история)
  inbox/              черновики от нетехнических участников (тир 3)
  roadmap.md          карта задач проекта

Принципы

  1. Doc near code. Меняешь фичу в PR — трогаешь соответствующую страницу доков в том же PR.
  2. Глоссарий — один термин, одно значение для разраба и аналитика. При новом термине — сначала в glossary.
  3. Решения фиксируем как ADR, а не разрастающимися *_AUDIT.md. Формат — в decisions/README.md.
  4. Устаревшее — в archive/, не удаляем. Датированные снимки и завершённые планы остаются для истории.

Не в docs/ (по конвенции остаются в корне)

  • README.md — витрина репозитория
  • CHANGELOG.md — журнал изменений
  • AGENTS.md, CLAUDE.md — инструкции для агентов/инструментов (читаются из корня)
Обзор