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

DOCS - 人类可读的文档
=====================================

描述
------------
除了帮助系统（针对人工智能优化）之外，还有两个人类可读的文档
具有 ASCII 图形和概述的文档。

文档级别
--------------------
BACH 具有三个文档级别：

  ┌────────────────────────────────────────────────────────────────┐
  │ 级别 │ 目标群体 │ 位置 │
  ├────────────────────────────────────────────────────────────────┤
  │ 文档/README.txt │ 开发人员 │ 文档/ │
  │ （开发） │ 贡献者 │ │
  ├────────────────────────────────────────────────────────────────┤
  │ ARCHITECTURE.md │ 开发者 │ 系统/ │
  │ (架构) │ 深度 │ │
  ├────────────────────────────────────────────────────────────────┤
  │ docs/help/*.txt │ AI 代理 │ system/docs/help/ │
  │ (操作) │ 克劳德等 │ │
  ├────────────────────────────────────────────────────────────────┤
  │ wiki/*.txt │ 全部 │ system/wiki/ │
  │ (专业知识) │ │ │
  └──────────────────── ────────────────── ──────────────────────────┘

文件
---------

  文档/README.txt
  ----------------
  开发文档 - 文档/文件夹结构概述。
  - 概念（CONCEPT_*.md）
  - 分析和报告
  - 存档的旧概念（_archive/）
  - 长期想法 (_ideas/)
  - 测试和报告 (_test_and_reports/)

  目标受众：开发者、贡献者
  格式：带有参考文献的纯文本

  系统/架构.md
  ----------------------
  开发人员的系统架构。
  - 愿景与设计理念
  - 高级架构图
  - 集线器和处理程序模式解释
  - 数据库模式可视化
  - 数据流程图
  - 扩展说明
  - 惯例

  目标受众：开发人员、贡献者、高级用户
  格式：带有 ASCII 图表的 Markdown

DEPARATION
----------
  docs/help/*.txt 操作参考，机器可读，一致
  docs/README.txt 开发人员概述、文件夹结构
  system/ARCHITECTURE.md 技术理解、架构、设计

  帮助是主要文档。
  docs/README.txt 和 ARCHITECTURE.md 详情请参阅帮助。

UPDATE
--------------
对于系统的重大变更，各级应
待更新：

  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 命名约定
