文档版本与维护说明
| 项目 | 内容 |
|---|---|
| 文档编号 | 99 |
| 所属模块 | 附录与参考资料 |
| 核心关键词 | 版本管理、维护说明、文档规范、更新日志、设定维护 |
一、文档体系概述
锚点共生文明设定体系由100份Markdown文档组成,编号从00至99,分为十大模块,每个模块10份文档。文档体系以SPEC.md(文档生成规范)为硬约束,以0000-衡元宙宇宙总览为总纲,各模块文档从不同维度展开详述,最终以90-99附录文档进行索引、汇总与整理。整个文档体系构成一个逻辑自洽、层次分明、互相引用的完整设定知识库。
文档体系的设计遵循"模块化、结构化、可扩展"三大原则。模块化指每个文档聚焦一个特定主题,独立成篇;结构化指所有文档遵循统一的格式规范,便于阅读与检索;可扩展指文档体系预留了充分的扩展空间,可以通过修订现有文档、增补新内容来持续完善设定。
二、版本编号规则
文档体系采用"主版本号.次版本号.修订号"的三级版本编号规则:
| 版本层级 | 编号规则 | 触发条件 | 示例 |
|---|---|---|---|
| 主版本号 | 从1开始递增 | 文档体系发生重大架构调整,如模块重新划分、核心设定变更 | v1.0 → v2.0 |
| 次版本号 | 从0开始递增 | 某份文档的核心内容发生实质性修订,或新增重要设定内容 | v1.0 → v1.1 |
| 修订号 | 从0开始递增 | 文档的文字修正、格式调整、术语统一等非实质性修改 | v1.0 → v1.0.1 |
当前文档体系的整体版本为v1.0,即首次完整发布版本。每份文档在其文档信息块中记录自身的版本号,文档体系的整体版本号在本文档中统一记录。
三、文档格式规范回顾
所有文档必须遵循以下统一格式规范(详细规范见SPEC.md):
3.1 文件命名
文件名格式为XX-文档标题.md,其中XX为00-99的两位数字编号,标题用中文,不含空格。
3.2 文档结构
每份文档必须包含以下结构要素:
- 一级标题:文档标题(与文件名一致)
- 文档信息块:编号、所属模块、核心关键词(3-5个)的表格
- 正文:至少3个二级标题章节,使用列表、表格等结构化元素
- 结语:简短总结段落
- 关联文档:列出2-3份相关文档编号与名称
3.3 字数要求
每份文档正文不少于800字(不含标题和元信息)。
3.4 写作风格
- 严肃、体系化的设定文档风格,类似百科全书/设定集
- 使用"衡元宙""锚点""共生"等统一术语
- 补充的新设定必须与已有设定逻辑自洽,符合"现实为基、规律升级"原则
四、维护组织与职责
4.1 设定维护委员会
设定维护委员会是文档体系的最高维护机构,由资深设定创作者、逻辑校验专家与用户代表组成。其核心职责包括:
- 审定文档体系的整体架构与重大修订方案
- 审核重大设定变更,确保与核心设定一致
- 裁决设定争议,给出权威解释
- 定期组织全面的设定一致性自查
- 发布文档体系的整体版本更新
4.2 模块维护者
每个模块指定一名模块维护者,负责该模块10份文档的日常维护。其职责包括:
- 跟踪模块内文档的设定一致性
- 审核模块内文档的修订申请
- 协调模块内文档之间的交叉引用
- 收集用户对模块内容的反馈与建议
- 定期向设定维护委员会汇报模块维护状态
4.3 文档创作者
任何符合条件的创作者都可以参与文档的创作与修订。创作者的职责包括:
- 按照格式规范创作或修订文档
- 确保创作内容通过设定矛盾自查表的检查
- 提交修订时附详细的修订说明
- 配合维护者与委员会的审核工作
五、修订流程
5.1 常规修订流程
- 提交申请:创作者向模块维护者提交修订申请,包括修订文档编号、修订内容说明与修订理由。
- 模块审核:模块维护者审核修订内容,重点检查格式规范与模块内一致性。审核通过后提交设定维护委员会。
- 委员会审定:设定维护委员会对修订内容进行最终审定,重点检查跨模块一致性与核心设定一致性。
- 执行修订:审定通过后,由模块维护者或原创作者执行文档修订。
- 版本更新:修订完成后,更新文档版本号,并在本文档的更新日志中记录。
- 关联同步:如果修订内容影响其他文档,须同步修订关联文档。
5.2 紧急修订流程
对于发现严重设定矛盾或错误的紧急情况,可启动紧急修订流程:
- 紧急报告:发现者立即向设定维护委员会报告问题。
- 快速审定:委员会在24小时内完成紧急审定,给出修订方案。
- 执行修订:指定专人立即执行修订。
- 事后补录:修订完成后补录修订申请与审核记录。
5.3 定期全面修订
设定维护委员会每年组织一次全面的文档体系修订,包括:
- 全面的设定一致性自查
- 用户反馈的集中处理
- 术语体系的统一与更新
- 索引文档的同步更新
- 文档格式的统一检查与修正
六、更新日志
v1.0(首次完整发布)
- 完成全部100份文档的创作与发布
- 建立完整的文档体系架构与格式规范
- 完成十大模块的内容覆盖
- 建立附录索引体系(术语词典、体系索引、法律索引、编年史、万族名录、人物组织、FAQ、自查表、扩展建议、版本说明)
后续版本更新记录区
(后续版本的更新内容将在此处追加记录,包括版本号、发布日期、主要更新内容摘要)
七、文档引用与交叉引用规范
7.1 内部引用
文档之间的交叉引用使用"文档编号-文档标题"的格式,例如"参见文档84《考古协议总纲》"。引用时应确保被引用文档确实存在且编号与标题正确。
7.2 术语引用
首次使用某个核心术语时,可注明参见文档90《术语词典》中的对应条目。后续使用同一术语时无需重复注明。
7.3 外部引用
如需引用设定体系之外的现实资料或虚构作品,应注明来源,并明确说明该引用属于"现实为基"原则下的参考素材,不代表设定体系对其内容的完全采纳。
八、质量保证机制
8.1 设定矛盾自查
所有新创作与修订的文档必须通过文档97《设定矛盾自查表》的全部检查项,包括核心设定一致性、跨模块逻辑一致性、文档格式规范三大类共40余项检查。
8.2 交叉审核
每份文档在正式发布前须经过至少一位其他创作者的交叉审核,重点检查跨模块的逻辑一致性与术语统一性。
8.3 用户反馈机制
文档体系设立用户反馈渠道,用户可以通过以下方式提交反馈:
- 报告设定矛盾与逻辑错误
- 提出术语不统一的问题
- 建议补充或修订特定内容
- 指出格式与文字错误
所有反馈由模块维护者分类处理,重要反馈提交设定维护委员会审议。
8.4 季度一致性报告
设定维护委员会每季度发布一份《设定一致性报告》,内容包括:
- 本季度发现的设定矛盾及处理情况
- 本季度文档修订统计
- 术语统一进展
- 用户反馈处理情况
- 下一季度维护计划
九、文档存储与分发
9.1 存储格式
所有文档以Markdown(.md)格式存储,确保跨平台可读性与版本管理的便利性。文档使用UTF-8编码,支持中文与特殊字符。
9.2 目录结构
文档统一存储在anchor-docs/目录下,文件名为XX-文档标题.md。SPEC.md作为规范文件也存储在同一目录下。
9.3 版本管理
建议使用Git等版本控制系统对文档进行版本管理,每次修订提交时附详细的commit message,记录修订内容与理由。
9.4 分发方式
文档体系可以通过以下方式分发:
- 打包为ZIP压缩包下载
- 部署为静态网站在线浏览
- 转换为PDF或EPUB格式阅读
- 导入知识库系统进行结构化管理
结语
文档版本与维护说明是锚点共生文明设定体系的"管理宪法"。它确立了文档体系的版本规则、维护组织、修订流程、质量保证机制与存储分发方式,确保这个由100份文档组成的庞大设定体系能够在持续生长的过程中始终保持秩序与一致性。一个好的设定体系不仅需要精彩的内容,更需要完善的维护机制来保障其长期健康发展。本文档正是这一机制的核心载体。
关联文档
- 0097-设定矛盾自查表
- 0090-术语词典
- 0000-衡元宙宇宙总览