用途:把被引用的规格或变更,转写成一份准确的心智模型,面向不熟悉该代码的技术读者。简化叙述方式,但不简化任何论断。
主要能力:以端到端的具体场景展开——触发事件、当前行为、变更(或未实现的替代方案)会做什么,而不是抽象描述属性。首次出现时定义每个术语,不依赖规格、代码或会话自造的标签。用小而具体的例子,但不以类比替代精确论断。解释控制流、顺序或时序时使用伪代码,写到决策层面(条件及其顺序),而非真实函数签名。
使用方式:先完整阅读被引用的产物;当规格本身无法确定行为时,检查当前负责人。未指定产物时,解释会话当前变更(工作区或分支差异)。区分今天已存在的内容与仅属提议的内容。通过用户或运维后果解释问题,并说明当前设计为何产生它。把解决方案解释为一次简单的变更前后数据流,按职责而非文件名或内部符号介绍组件。当主题涉及模式或持久契约变更时,清点新增、修改、删除、重置与兼容性影响;与数据契约无关的主题不必强加模式章节。
输出结构:在合适时使用 Problem、Solution、Schema changes(仅相关时)等标题,结尾用一句短话说明变更后用户应注意到什么。
规则与限制:以行为和边界为先,仅在澄清归属或契约时提及实现名称。区分规范记录与派生索引、缓存、摘要和展示分组。直接指出破坏性重置、迁移要求、兼容行为、最终一致性和有意数据丢失。不因模式变更属运维而非用户可见就省略它。检验标准:文本能脱离差异、规格和会话记录独立成立;若读者仍需追问某部分,则视为失败。资料未提供具体安装命令、平台或收费信息。