# Portability: UNIVERSAL
# Last validated: 2026-05-17
# Next review: 2027-05-17

DOCS - Удобочитаемая документация
=====================================

ОПИСАНИЕ
------------
Помимо справочной системы (оптимизированной для ИИ), есть две удобочитаемые.
Документация с графикой ASCII и обзорами.

УРОВНИ ДОКУМЕНТАЦИИ
--------------------
BACH имеет три уровня документации:

  ┌───────────────────────────────────────────────────────────────┐
  │ УРОВЕНЬ │ ЦЕЛЕВАЯ ГРУППА │ РАСПОЛОЖЕНИЕ │
  ├──────────────────────────────── ───────────────────────────────┤
  │ docs/README.txt │ Разработчик │ docs/ │
  │ (Разработка) │ Участники │ │
  ├──────────────────────────────── ───────────────────────────────┤
  │ ARCHITECTURE.md │ Разработчик │ system/ │
  │ (Архитектура) │ Глубокая │ │
  ├──────────────────────────────── ───────────────────────────────┤
  │ docs/help/*.txt │ Агенты ИИ │ system/docs/help/ │
  │ (Оперативник) │ Клод и т. д. │ │
  ├──────────────────────────────── ───────────────────────────────┤
  │ wiki/*.txt │ Все │ system/wiki/ │
  │ (экспертиза) │ │ │
  └───────────────────────────────────────────── ─────────────────────────┘

ДОКУМЕНТЫ
---------

  документы/README.txt
  ---------------
  Документация по разработке — Обзор структуры документов/папок.
  - Концепции (CONCEPT_*.md)
  - Анализы и отчеты
  - Архив старых концепций (_archive/)
  - Долгосрочные идеи (_ideas/)
  - Тесты и отчеты (_test_and_reports/)

  Целевая аудитория: разработчики, участники.
  Формат: Обычный текст со ссылками

  система/ARCHITECTURE.md
  ----------------------
  Архитектура системы для разработчиков.
  - Видение и философия дизайна
  - Диаграммы архитектуры высокого уровня
  - Объяснение шаблона Hub & Handler
  - Визуализация схемы базы данных
  - Диаграммы потоков данных
  - Инструкции по расширению
  - Соглашения

  Целевая аудитория: разработчики, участники, опытные пользователи.
  Формат: Markdown с диаграммами ASCII

DEPARATION
----------
  docs/help/*.txt Оперативная справка, машиночитаемая, согласованная
  docs/README.txt Обзор разработчика, структура папок
  system/ARCHITECTURE.md Технические знания, архитектура, дизайн

  help - это ПЕРВИЧНАЯ документация.
  Дополнительную информацию в документах README.txt и ARCHITECTURE.md можно найти в справке.

ОБНОВЛЕНИЕ
--------------
Для серьезных изменений в системе все уровни должны
будет обновлено:

  1. docs/help/*.txt — команды, операции (ВСЕГДА будьте в курсе событий)
  2. docs/README.txt — для изменений концепции/папки.
  3. system/ARCHITECTURE.md — для изменений архитектуры

GITHUB PUBLISHING
------------------------
При публикации на GitHub:

  - Ссылка system/ARCHITECTURE.md как основная запись
  - docs/README.txt для обзора разработчиков.
  - упомянуть справочную систему как интегрированную документацию

ПУТИ К ФАЙЛАМ
----------
  docs/README.txt Обзор разработчика
  system/ARCHITECTURE.md Архитектурная документация
  system/docs/help/*.txt Оперативная справка (эти файлы)
  system/wiki/*.txt Базовые знания

СМОТРИТЕ ТАКЖЕ
----------
  bach --help list         Все разделы справки
  bach wiki list           Все статьи Wiki
  docs/help/practices.txt Принципы архитектуры
  docs/help/naming.txt Соглашения об именах
