文档模块化模板
文档模块化规范
版本:v3.1
更新日期:2026-07-25目的:定义一类文档的通用逻辑架构。该架构由三个具有明确输入-职责-输出边界的模块组成,模块间的数据依赖构成有向无环图,不依赖任何人员角色、领域假设或管理场景。
形式化抽象:设文档为三元组
(M₁, M₂, M₃),其中M₁ = (input₁, T₁, output₁),M₂ = (input₂, T₂, output₂),M₃ = (input₃, T₃, output₃),满足input₂ = output₁,input₃ = output₂ ∪ output₁.G。M₁.T₁为问题归约变换,M₂.T₂为空间构造变换,M₃.T₃为路径归约变换。整篇文档即为这组变换的复合T₃ ∘ T₂ ∘ T₁,其不动点为满足G的终态。适用范围:任何需要结构化分析、设计或论证的方案性文本。
使用方式:依次填充各模块。若某模块的输入条件不满足(前置模块未完成),则该模块标记为
[pending]。模块间的接口继承关系由下文各节的"输入"节显式声明。
目录
- 文档模块化规范
- 目录
- 1. 元信息层
- 2. 模块一:问题空间分析
- 2.1 输入
- 2.2 变换
- 2.3 输出
- 2.4 完整性约束
- 3. 模块二:解空间构造
- 3.1 输入
- 3.2 变换
- 3.3 输出
- 3.4 完整性约束
- 4. 模块三:方案归约与验证
- 4.1 输入
- 4.2 变换
- 4.3 输出
- 4.4 完整性约束
- 5. 格式与命名约定
- 5.1 标题层级
- 5.2 命名约定
- 5.3 表格
- 5.4 图式
- 5.5 代码块
- B. 具象模板
1. 元信息层
元信息层不属于模块体系。它仅记录文档标识数据,不参与下游推理。
# 标题| 属性 | 约束 | 记法 |
|---|---|---|
| 版本 | 必填 | vMAJOR.MINOR |
| 日期 | 必填 | YYYY-MM-DD |
| 前置文档 | 推荐 | 指向提供输入的文档标识 |
2. 模块一:问题空间分析
语义:将初始状态(未结构化的需求或现象)变换为形式化的问题描述和可验证的目标谓词。
2.1 输入
| 参数 | 类型 | 说明 |
|---|---|---|
初始状态 | 非结构化文本 | 待分析领域的状态描述 |
边界条件 | 约束集 | 分析范围的上下界 |
2.2 变换
识别初始状态与期望状态之间的偏差,并将各偏差归约至其根本原因。
| 偏差标识 | 可观测表现 | 根本原因 | 证据链 |
|---|---|---|---|
δ₁ | 现象描述 | 根因命题 | 支撑该归约的事实序列 |
δ₂ | 现象描述 | 根因命题 | 支撑该归约的事实序列 |
2.3 输出
偏差集 D = {δ₁, δ₂, ...} 目标谓词 G = 在 [约束] 下,[可观测指标] 满足 [判定条件]D为模块二的输入约束。G为模块三的验证基准。
2.4 完整性约束
| 检查项 | 约束 | 违规后果 |
|---|---|---|
| 输入节 | 输入节非空 | 分析范围未界定 |
| 偏差证据 | 每个偏差均有证据链 | 归约不可追溯 |
| 目标谓词 | G可判定 | 验证不可执行 |
3. 模块二:解空间构造
语义:在偏差集
D和目标谓词G的约束下,构造一个满足所有约束的可解空间。
3.1 输入
D:模块一的偏差集G:模块一的目标谓词
3.2 变换
定义解空间中的基本构件及其关系,使得该结构在理论上满足G。
[领域记法] 构件 C₁: {属性集} 构件 C₂: {属性集} 关系 R(C₁, C₂): 语义标签3.3 输出
构件空间 Ω = {C₁, C₂, ...} 约束集 Γ = {γ₁ | γ₁ 来自 D} ∪ {γ₂ | γ₂ 来自资源边界}Ω和Γ为模块三的输入。
3.4 完整性约束
| 检查项 | 约束 | 违规后果 |
|---|---|---|
| 构件空间 | Ω非空 | 无解 |
| 构件定义 | 每个构件均有属性定义 | 构件不可实例化 |
4. 模块三:方案归约与验证
语义:将构件空间
Ω在约束Γ下的可行路径归约为有序步骤序列,并以目标谓词G为基准验证其完备性。
4.1 输入
Ω:模块二的构件空间Γ:模块二的约束集G:模块一的目标谓词
4.2 变换
将解空间映射为步骤序列,每一步应满足:
- 输入是构件
C_i的一个子集 - 输出是构件
C_j的一个子集或目标谓词G的子条件 - 变换不违反任何
γ ∈ Γ
| 步骤 | 输入依赖 | 输出产物 | 满足的子条件 |
|---|---|---|---|
S₁ | C₁ | 验证核心路径 | G的必要条件g₁ |
S₂ | S₁的输出 | 扩展覆盖 | G的必要条件g₂ |
S₃ | S₂的输出 | 闭包验证 | G的充分条件 |
4.3 输出
步骤序列 Σ = ⟨S₁, S₂, S₃⟩ 验证结论: - 完备性:Σ 覆盖 G 的 [全部/部分] 必要条件 - 一致性:∀σ ∈ Σ, transform(σ) ⊢ Γ - 闭合性:Σ 的终态满足 G 的充分条件 [是/否/部分]4.4 完整性约束
| 检查项 | 约束 | 违规后果 |
|---|---|---|
| 步骤序列 | Σ非空 | 无归约路径 |
| 依赖可达 | 每步骤的输入依赖均在Ω中 | 依赖不可满足 |
| 目标覆盖 | G被Σ覆盖 | 方案不完备 |
5. 格式与命名约定
5.1 标题层级
| 层级 | 记法 | 语义 |
|---|---|---|
| H1 | # | 文档标识 |
| H2 | ## | 模块/章节边界 |
| H3 | ### | 模块内节(输入/变换/输出/约束) |
| H4 | #### | 子节 |
约束:禁止层级跳跃(H2→H4)。
5.2 命名约定
| 公理 | 说明 |
|---|---|
| 自描述 | 名称应蕴含其指称对象的语义,避免歧义缩写 |
| 一致 | 同类实体在同一文本内使用同一模式命名 |
| 路径归一 | 文件路径统一使用/ |
5.3 表格
| 左对齐 | 居中 | 右对齐 | |--------|:----:|-------:|约束:分隔行必须存在;文本左对齐,数值右对齐,状态居中;连续表格的前后保留空行;列数 > 6 时应考虑分解。
5.4 图式
| 类型 | 语义域 |
|---|---|
graph | 拓扑关系、流程图 |
sequenceDiagram | 时序交互 |
graph LR | 定向依赖 |
graph TB | 分层包含 |
mindmap | 概念分类 |
gantt | 时间序列 |
约束:使用subgraph表达嵌套域;使用classDef表达类型标注;-->表示强依赖,-.->表示弱关联。
5.5 代码块
代码块必须标注语言标识符;前后保留空行;单块超过 30 行时应按语义切分。
```语言 体> **注意:** 以上代码块约定适用于所有标记块,包括示例代码和模板定义。 ### 5.6 完整性约束 | 检查域 | 约束 | 违规后果 | |--------|------|---------| | 元信息 | 版本、日期均已标注 | 文档不可入档 | | 标题层级 | 无层级跳跃 | 结构解析异常 | | 代码块 | 均有语言标识 | 渲染降级 | --- ## 附录:模板变体 ### A. 抽象模板 > 无任何领域预设。使用者需将 `构件`、`约束`、`步骤` 等范畴映射到具体领域。 ```text [标题] -- 元信息 版本:v1.0 | 日期:YYYY-MM-DD -- 问题空间分析 | 偏差 | 表现 | 根因 | 证据 | |------|------|------|------| | d1 | 现象 | 原因 | 证据项 | 目标谓词 G:[可判定的条件] -- 解空间构造 构件: - C1: [属性] - C2: [属性] 约束 GAMMA: - g1: [约束命题] -- 方案归约与验证 | 步骤 | 输入依赖 | 产物 | 满足的子条件 | |------|---------|------|-------------| | S1 | C1 | x | g1 | | S2 | x | y | g2 |B. 具象模板
预设该文本将涉及形式化程度较高的结构定义(接口、类型、协议等)。
[标题] -- 元信息 -- 问题空间分析 -- 解空间构造 -- 结构定义 [[记法]] 类型 T1 { field_a: t1, field_b: t2 } 型构 T2 { 关联: T1 } [[/记法]] -- 归约规则 -- 交互协议 -- 方案归约与验证适用范围重申:此架构适用于但不限于技术方案设计、系统架构分析、协议定义、问题域建模等场景。三个模块的顺序约束保证推理路径的单向性,避免循环依赖导致的论证失效。
