文档清理器

其他 社区

技能解读

当前原文的自动摘译,尚未人工审校。

核心原则(管理两种模式)

删除前的批判性评估。切勿盲目删除。在建议删除之前分析每个部分的独特价值。目标是在不丢失信息的情况下进行缩减。这控制着该技能中的每个删除形状的操作,而不仅仅是合并:归档文档、删除派生值和删除交叉引用都是删除,并且都首先进行相同的分析。 “看起来多余”并不是这样的分析。

你处于哪种模式?

用户说/情况 · 模式“我更改了 X”/存在差异/更新了程序 · 1 — 更改后治理“哪些文档现在是错误的”、“检查过时的命令/路径” · 1 — 更改后治理“清理文档”、“此文件太多”、“合并这些” · 2 — 合并 一个主题分布在多个没有明确所有者的文件中 · 2 — 合并

漂移测试(两种模式的核心)

在将任何价值写入文档之前,以及在决定现有的价值是否值得一用时,请按顺序问这三个问题,并在第一次点击时停止: 1. 这可以根据此处或权威来源中已记录的详细信息来计算吗? → 这是一个派生值。不要写它。当有人问时计算一下。

职位不给予任何豁免

无论它位于何处,事实就是事实。所有这些都是用于上述测试目的的正文,并且所有这些都是过时值实际上能够通过审核的地方:frontmatter · YAML/JSON 元数据 · 括号旁注 · 索引表中的描述列 · 复选框状态 · 真实内容之前的介绍性框架 · 跨文档脚注 · 添加到表中的额外列 · 散文中留下的提交消息形状的注释

什么才算事实

任何随时间变化并在某处有权威定义的事物:数字、状态、所有权、关系、分类、规则、决策来源、日期、计数。业务规则也很重要——“所有报价均通过财务主管”被定义一次并被引用,而不会在每个下游文档中重述。

流狐档案 运行与权限由流狐静态检查推断,不代表作者声明或实际测试结果。
领域
通用
作者声明的智能体
未找到明确声明;不据此推断已兼容或已测试
静态检查
88 / 100 · 启发式扫描,不代表运行安全
运行环境证据
未执行;当前没有隔离运行测试证据
作者 / 版本 / 许可证
@daymade · 未声明许可证
上下文用量评级
中等消耗
接入复杂程度
需简单配置
是否需要外部接口密钥
不需要
兼容的系统
未声明(默认跨平台)
运行环境要求
Python
检测到的文件与系统行为
  • 只读
  • 允许写入 / 修改
  • 命令执行
  • 读取环境变量
网络行为
允许外网请求
安装命令数
无(仅作为资料)

需要注意: 未声明工具权限范围;实际权限由运行环境决定。

01
第一阶段:发现

识别涵盖该主题的所有文档文件,并在搜索之前说明您搜索的边界(一个目录、一个套件、一个项目)——与模式 1 步骤 1 使用的有限范围规则相同。给定“文档”且没有边界的两个代理会合并不同的文件集。在该边界内进行主题关键字扫描是常用方法 - 注意 `-F`,因为像 `C++`、`.NET` 或 `v1.0.0` 这样的主题术语是文字

02
第二阶段:价值分析

对于每个文档,建立一个逐节的表: 节 · 行 · 值 · 原因 API 参考 · 25 · 保留 · 唯一的端点文档设置步骤 · 40 · 压缩 · 冗长但必要的环境变量表 · 30 · 删除 · 复制`README.md`中的表,这是权威的

03
第三阶段:整合计划

用实际数字提出目标结构,并提出它以征求同意——这是第四阶段的计划,要求您在删除任何内容之前获得批准:行数和减少量是您现在可以进行的测量。 “保留价值”不是:在计划时,删除方会声称自己的删除是无害的,这是该技能要删除的自我证明形式。

04
第四阶段:执行

即使 git 可以撤消,删除某人的文档对于读者来说也是不可逆转的。在步骤 3 之前提出第 3 阶段计划并取得一致意见。第 3 阶段说“提议”是有原因的;核心原则决定了您分析的仔细程度,而不是您是否获得授权。如果您在无人值守的情况下运行并且无法询问,请执行步骤 1-2,停止并报告您要删除的内容。

讨论

基于 GitHub Discussions。登录 GitHub 即可参与讨论、点赞、订阅更新。