知行札记

把方法接入规范与协作

划分方法、风格、专项与流程的职责,让多人和 Agent 复用依据、处理缺口,并清楚维护成果与规则。

当多个人或多个 Agent 一起研究和写作时,容易出现不同位置各写一套相近要求、同一结论多次检查、局部成果有依据却无法拼成完整文章等问题。规范与流程需要让参与者知道当前任务要满足什么、每项要求由谁维护,以及发现缺口后回到哪里修正。本章说明一种按职责组织的方法,并以文档仓库为例解释它的实际取舍。

从反复出现的问题形成要求

先指出具体问题和影响,再判断它需要哪类解决办法。例如“把旧版单元测试写成当前线上结果”涉及证据性质和结论范围;“同一个定义在两篇文件中改成不同名称”涉及表达与维护;“某位读者偏爱紧凑文字”涉及本次风格选择。它们可能同时出现,负责的要求不同。

一条有执行用途的规则应说明适用对象、需要采取的动作以及怎样判断已满足。动作可以是核对关键版本、补齐机制联系或报告未完成范围。满足判断应对应实际成果,例如“读者可以找到支撑关键主张的已读材料和适用条件”。只写“认真研究”“写得清楚”,参与者很难识别缺口。

规则来自来源、案例和本地任务需要的综合选择。实践指南提供可借鉴的方法,某项实验提供特定情境的结果,仓库要求提供生产边界。将它们转为规范时,还要说明哪些条件沿用、哪些做法裁剪,以及当前没有证明的效果。跨领域采用的证据与限制见研究与证据。

让每份规则负责一种判断

下列职责可以分别维护,并通过入口组合使用。实际文件数取决于维护需要;表中的分工帮助定位规则所属位置。

职责主要解决的问题与其他要求怎样连接
研究方法问题、证据、推理和充分性怎样成立为写作提供可用判断,为质量检查提供支持范围
通用写作读者如何取得概念、关系、依据和条件使用研究结果,按专项补齐特有联系
质量标准缺陷影响什么,是否需要继续修正或限制交付根据已执行动作及成果判断,返回相应研究或写作
风格指引语气、节奏、密度、示例领域和媒介如何选择在主要解释和证据要求满足的范围内调整
专项规范某类内容有哪些特有对象、关系和边界补充共同要求,用于当前任务的相关部分
生产流程谁负责、如何协作、成果放哪里、怎样交付安排执行和回返,不复制完整方法条款
技术格式文件、元数据、链接和组件有哪些接口工程检查核对接口,内容判断继续由生产承担

例如一次架构任务需要说明异步消息:架构要求核对发送者、接收者、部署位置和责任边界,技术讲解要求建立接受、处理、持久化和重试之间的联系。相同案例与代码核查可以同时支持两种判断,专项组合无需生成两份重复报告。

风格也可以单独一处维护。不同内容需要不同表达,不必因此为每种语气复制研究和质量规则。一份紧凑比较可以压缩熟悉基础,一篇陌生机制解释可以逐步建立状态;决定结论成立的条件继续保留。写作与风格给出具体选择方式。

用入口控制适用范围和状态

入口应帮助执行者找到当前采用的规则、判断专项何时适用,并定位冲突的维护位置。候选提案、正式要求、历史解释和正文发布状态分别表达:规则被采用后可在本地执行,研究文章仍可能是草稿。

通用规则先适用于当前任务,专项按对象和阅读问题补充。架构图中出现一个技术名词,不必把每个节点扩成教程;陌生机制影响判断时才展开相关知识。简单事实核查也无需机械执行所有研究方法。

遇到规则冲突,先核对双方的对象、读者、用途、版本与适用条件。对象不同可以分别执行,范围可裁剪时缩小到实际问题。确需用专项替代共同要求,应明确被替代部分、条件、替代动作和理由,经相应采用决定登记;真实性、证据匹配、主要解释完整和验证报告准确仍是必须维持的性质。具体项目还需遵守本身的授权边界。

把协作安排到可核查的子问题

主负责人先把任务落实为问题与成果范围,再把能独立完成的工作分给协作者。适合并行的任务包括查找原始来源、比较方案、核对实现路径或审阅关键解释。它们需要共同理解主要阅读目标,并有清楚的文件或问题边界。

给子 Agent 的任务需要包含:要回答的具体问题,允许使用或修改的范围,所需结果与定位,以及实际验证授权。比如让一个 Agent 比较两种文档方法,应取得比较维度、来源和限制;让另一个 Agent 核查代码,应取得有效入口、条件和支持范围。只有一句“帮我研究一下”,容易产生与最终成果脱节的大量内容。

子 Agent 返回的信息由主负责人核查并整合。关键依据需要实际读取,代码结论需要接回有效路径,意见需要指出问题所在位置及其影响。多个 Agent 给出相同说法时,还要识别是否依赖同一来源;数量无法单独构成独立验证。

在同一工作树中协作编辑,可以按文件分配所有权,避免互相覆盖。主负责人最后统一术语、范围、跨页链接和解释承接,并检查不同页面是否重复维护同一完整内容。此类安排是协作方法,速度或质量是否提高要据实际结果评价。

在研究、写作和检查间回返

以一篇“某种缓存方案是否适合当前需求”的文章为例,研究先比较需求、机制、成本和资料范围;起草时发现结论依赖未确认的失效条件,就返回核查;机制已经确认但文字省略中间联系,则补解释;引用只支持某个版本时,缩小主张或继续取证。质量判断把问题送回受影响环节。

已读规范和已完成的核查可以沿用。范围、版本、读者基础、关键结论或依赖改变时,重查受影响部分;无变化时不必在每个阶段重新取得同一材料。交付报告说明完成的结果、依据和验证边界,过程中的临时分工稿按必要用途收尾。

技术交付与内容核查相接。格式、构建和链接检查发现技术错误时修正相关文件;发布过程中发现事实错误时返回内容生产。公开范围、外部账户或实际应用验证仍需当前授权,不由一份文件或 Agent 意见扩大。

按用途维护调研、专题与正式规范

调研回答研究问题,保留足以评估选择的来源比较、推理、实验与局限;专题建立成熟方法和应用之间的连续解释;正式规范规定项目当前执行的要求。它们可以引用,主要解释仍要在各自承诺的成果范围内完成。

整理同一主题时,应给完整教学、具体研究比较和当前条款各自确定维护位置。例如方法讲解已经迁入专题,研究中可以保留用于判断其适用性的短说明和实验记录,避免再维护相同教程。迁移时必要证据和条件随内容保留,相关导航与引用同步修正。已无独立用途的候选页或接入步骤,在授权范围内收敛。

在 doc-test 中,apps/site/docs/production.md 维护生产与归属,apps/site/docs/content.md 维护技术格式,apps/site/docs/standards/ 集中已生效的研究、写作、质量、单文件风格和两个专项。research/write skills 从统一入口选择规范;采用决定由 docs/adr/0011-content-production.md 记录。这是当前仓库采用的组织方式,其比较与取舍依据属于独立调研。其他项目可依据自身入口、任务组合和维护负担调整文件布局。

随具体缺陷修订规则

规则使用中反复出现遗漏、歧义、来源失效、职责冲突或重复劳动时,先定位受影响判断,再修订归属文件。补一个专项,需要有共同要求未充分表达的特有问题、明确适用条件和可判断的结果;一次性产品设置更适合留在其文档中。

修改后用代表性内容核对:原问题能否被识别,正常任务是否增加无用途的步骤,关联规则是否保持一致。规则维护通过现有源文件、Git 差异和必要依据完成;长期保存的材料要有复核或使用价值。文档语义变化的具体检查见质量与长期维护。

最后更新于

本页目录