Doc Review

以目标读者视角检查文档的可理解性、歧义和链接;需要独立读者复核时使用。

notnotype f211b2a 952 B Updated

File contents

文档审查

$ARGUMENTS 指定范围;缺省时从当前未提交文档改动确定对象。

  1. 读取目标文档及目标读者应有的上下文,检查术语、指代、前后矛盾、必要示例和链接。
  2. 短文直接审查;独立视角有价值或用户明确要求时委派,关联文档成组,不按文件数拆任务或强制模型等级。
  3. 报告具体妨碍理解的问题:位置、必要原文、原因和影响。可合理从上下文回答的疑问不判为缺陷;无阻碍时说明未发现问题。
  4. 仅审查请求保持只读;已授权修改则修复范围内问题并复核,不重复等待批准。

完成条件

范围内文档已读,理解障碍和链接问题有明确结论。修改后的结构、链接和语义已按适用文档规范核对。

notnotype/neuro-book/tree/main/.agents/skills/doc-review commit f211b2aab8

Frequently asked questions

npx skillmds@latest add notnotype/doc-review