文档模块化模板

文档模块化规范版本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₂): 语义标签渲染错误:Mermaid 渲染失败: Lexical error on line 2. Unrecognized text. graph LR C₁ --|R| C₂ -- C₃ -------------^3.3 输出构件空间 Ω {C₁, C₂, ...} 约束集 Γ {γ₁ | γ₁ 来自 D} ∪ {γ₂ | γ₂ 来自资源边界}Ω和Γ为模块三的输入。3.4 完整性约束检查项约束违规后果构件空间Ω非空无解构件定义每个构件均有属性定义构件不可实例化4. 模块三方案归约与验证语义将构件空间Ω在约束Γ下的可行路径归约为有序步骤序列并以目标谓词G为基准验证其完备性。4.1 输入Ω模块二的构件空间Γ模块二的约束集G模块一的目标谓词4.2 变换将解空间映射为步骤序列每一步应满足输入是构件C_i的一个子集输出是构件C_j的一个子集或目标谓词G的子条件变换不违反任何γ ∈ Γ渲染错误:Mermaid 渲染失败: Lexical error on line 2. Unrecognized text. graph LR S₁ -- S₂ -- S₃ -------------^步骤输入依赖输出产物满足的子条件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 } [[/记法]] -- 归约规则 -- 交互协议 -- 方案归约与验证适用范围重申此架构适用于但不限于技术方案设计、系统架构分析、协议定义、问题域建模等场景。三个模块的顺序约束保证推理路径的单向性避免循环依赖导致的论证失效。