# yunmin311/universal-text-structure-standard architecture

> Architecture diagram of the GitHub repository yunmin311/universal-text-structure-standard, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-09-29). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/yunmin311/universal-text-structure-standard
- Repository: https://github.com/yunmin311/universal-text-structure-standard

## Overview

该仓库提供通用文本结构与排版规范，并附带轻量 Markdown 检查器。主要流程是作者先按规范撰写和修订文档，再运行检查获取诊断，最后人工复核语义与结构；自动检查不替代人工判断。图依据 README 的能力说明和提供的验证器摘录构建；未采样的子系统仅按文档明确描述表示，未推断其内部调用关系。

Main entry points: [`STANDARD.md`](https://github.com/yunmin311/universal-text-structure-standard/blob/main/STANDARD.md) (写作规范), [`scripts/validate.py`](https://github.com/yunmin311/universal-text-structure-standard/blob/main/scripts/validate.py) (文档检查器), [`FORMAT_RULES.yaml`](https://github.com/yunmin311/universal-text-structure-standard/blob/main/FORMAT_RULES.yaml) (规则登记表), [`USAGE.md`](https://github.com/yunmin311/universal-text-structure-standard/blob/main/USAGE.md) (长文使用指南)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_standard["规范资产"]
  node_standard_doc["写作规范<br/>[STANDARD.md]"]
  node_rules["规则登记表<br/>[FORMAT_RULES.yaml]"]
  node_schema["规则 Schema"]
  node_good_examples["正例"]
  node_bad_examples["反例"]
  node_references["来源说明<br/>[README.md]"]
end

subgraph group_validation["检查工具"]
  node_validator["文档检查器<br/>[validate.py]"]
  node_diagnostics["检查诊断"]
end

subgraph group_guidance["使用与维护"]
  node_usage["长文使用指南<br/>[USAGE.md]"]
  node_changelog["版本记录<br/>[CHANGELOG.md]"]
end

node_author(("文档作者"))
node_markdown["待检文档"]
node_maintainer(("规范维护者"))

node_author -->|"遵循规范"| node_standard_doc
node_author -->|"参考流程"| node_usage
node_usage -->|"引导阅读"| node_standard_doc
node_usage -->|"引导示例"| node_good_examples
node_standard_doc -->|"对应规则"| node_rules
node_standard_doc -->|"配套示例"| node_good_examples
node_standard_doc -->|"展示反例"| node_bad_examples
node_rules -->|"受其约束"| node_schema
node_validator -->|"读取规则"| node_rules
node_validator -->|"校验结构"| node_schema
node_validator -->|"扫描文档"| node_markdown
node_validator -->|"生成诊断"| node_diagnostics
node_diagnostics -->|"供其复核"| node_author
node_author -->|"撰写修订"| node_markdown
node_maintainer -->|"维护规则"| node_rules
node_maintainer -->|"维护规范"| node_standard_doc
node_maintainer -->|"记录演变"| node_changelog
node_references -->|"说明来源边界"| node_maintainer

click node_standard_doc "https://github.com/yunmin311/universal-text-structure-standard/blob/main/STANDARD.md"
click node_rules "https://github.com/yunmin311/universal-text-structure-standard/blob/main/FORMAT_RULES.yaml"
click node_schema "https://github.com/yunmin311/universal-text-structure-standard/blob/main/schemas/format-rules.schema.json"
click node_good_examples "https://github.com/yunmin311/universal-text-structure-standard/tree/main/examples/good"
click node_bad_examples "https://github.com/yunmin311/universal-text-structure-standard/tree/main/examples/bad"
click node_references "https://github.com/yunmin311/universal-text-structure-standard/blob/main/references/README.md"
click node_validator "https://github.com/yunmin311/universal-text-structure-standard/blob/main/scripts/validate.py"
click node_usage "https://github.com/yunmin311/universal-text-structure-standard/blob/main/USAGE.md"
click node_changelog "https://github.com/yunmin311/universal-text-structure-standard/blob/main/CHANGELOG.md"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_standard_doc,node_rules,node_schema,node_good_examples,node_bad_examples,node_references toneBlue
class node_validator,node_diagnostics toneAmber
class node_usage,node_changelog toneMint
class node_author,node_markdown,node_maintainer toneIndigo
```

## Components

### 规范资产

- [写作规范](https://github.com/yunmin311/universal-text-structure-standard/blob/main/STANDARD.md): `STANDARD.md`
- [规则登记表](https://github.com/yunmin311/universal-text-structure-standard/blob/main/FORMAT_RULES.yaml): `FORMAT_RULES.yaml`
- [规则 Schema](https://github.com/yunmin311/universal-text-structure-standard/blob/main/schemas/format-rules.schema.json): `schemas/format-rules.schema.json`
- [正例](https://github.com/yunmin311/universal-text-structure-standard/tree/main/examples/good): `examples/good`
- [反例](https://github.com/yunmin311/universal-text-structure-standard/tree/main/examples/bad): `examples/bad`
- [来源说明](https://github.com/yunmin311/universal-text-structure-standard/blob/main/references/README.md): `references/README.md`

### 检查工具

- [文档检查器](https://github.com/yunmin311/universal-text-structure-standard/blob/main/scripts/validate.py): `scripts/validate.py`
- **检查诊断**

### 使用与维护

- [长文使用指南](https://github.com/yunmin311/universal-text-structure-standard/blob/main/USAGE.md): `USAGE.md`
- [版本记录](https://github.com/yunmin311/universal-text-structure-standard/blob/main/CHANGELOG.md): `CHANGELOG.md`

### Other components

- **文档作者**
- **待检文档**
- **规范维护者**

## Connections

- 文档作者 → 写作规范: 遵循规范
- 文档作者 → 长文使用指南: 参考流程
- 长文使用指南 → 写作规范: 引导阅读
- 长文使用指南 → 正例: 引导示例
- 写作规范 → 规则登记表: 对应规则
- 写作规范 → 正例: 配套示例
- 写作规范 → 反例: 展示反例
- 规则登记表 → 规则 Schema: 受其约束
- 文档检查器 → 规则登记表: 读取规则
- 文档检查器 → 规则 Schema: 校验结构
- 文档检查器 → 待检文档: 扫描文档
- 文档检查器 → 检查诊断: 生成诊断
- 检查诊断 → 文档作者: 供其复核
- 文档作者 → 待检文档: 撰写修订
- 规范维护者 → 规则登记表: 维护规则
- 规范维护者 → 写作规范: 维护规范
- 规范维护者 → 版本记录: 记录演变
- 来源说明 → 规范维护者: 说明来源边界