mcpField
R
review-writing

review-writing

github.com/doodledood文档处理78103 次安装1 天前更新
代码仓库

关于 review-writing

review-writing 用于依据适用的写作规范审查指定文本。它区分文档与人文叙述类写作,报告有依据的问题,并将编辑决定留给作者。

主要功能

  1. 01审查文件、目录、匹配模式或文本
  2. 02选择文档或叙述类规范
  3. 03检查通用文本要求
  4. 04按影响程度判定问题等级
  5. 05报告依据与具体修改建议

适用场景

  1. 01审查技术文档
  2. 02检查文章或营销文案
  3. 03按指定政策评估文本

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/doodledood/manifest-dev --skill review-writing

安装后在 Claude Code 中输入/review-writing确认已加载。

包含的文件

除 SKILL.md 外,安装时一起下载的参考资料和脚本。

references/
DOCS-STYLE-REFERENCE.md
PROSE-FLOOR-REFERENCE.md
WRITING-REFERENCE.md

详细介绍

review-writing — 以自身语体审阅文案

指出文本偏离其适用写作规范之处。只做审阅:你负责发现并说明问题,作者负责决定和修改。

输入

$ARGUMENTS 用于指定要审阅的内容——文件路径、目录、glob,或粘贴的文本。也可以明确指定语体(register=docs、register=voice)以覆盖自动检测。清单门禁的 Evidence 会在运行所选评估器下指定语体,从而启用此技能;门禁会指定语体以及由调用方选择的验收政策。

没有参数时,审阅工作树中最近修改的文案文件,并说明选中了哪个文件。如果候选不明确,或没有任何文案内容发生变化,请询问要审阅什么,而不要猜测。如果无法询问,则审阅证据最能支持的候选项,并在报告开头说明这一假设;如果完全没有候选项,则报告 BLOCKED,并说明缺少什么。

语体与评级

有两种语体,各自遵循不同的规则。按后果对问题分类;验收政策由调用方提供:

语体适用内容规则
docs规范、提案、报告、正式和技术文档、README、参考资料、API 文档references/DOCS-STYLE-REFERENCE.md
voice文章、博客文章、营销和社交文案、新闻简报、叙事、创意写作references/WRITING-REFERENCE.md

每种语体都包含共同的基准要求:references/PROSE-FLOOR-REFERENCE.md 列出了两种语体通用的规则,包括无障碍与包容性用语的基准要求;违反这些要求的问题,与违反语体规则的问题采用相同的标准评级和报告。不支持只调用基准要求。

根据所加载语体的严重性等级为每个问题评级。两种等级都按后果评级;在两者中,Low 都表示润色问题或任何类型的小问题:风格、命名、结构或其他方面。所加载语体的基准文件会说明其具体受众成本。明确要求仍然具有约束力;若将正确性或安全性问题,或被违反的明确承诺评为 Low,应先依据证据重新评级,再应用调用方的政策。

调用方提供验收主张,以及任何明确要求的严重性或类别政策。对于基于主张的门禁,应将每项所称的问题与目标读者、含义或效果关联起来,并说明具体成本;仅有评级不足以否定该主张。如提供了明确阈值,应予以保留。未要求门禁时,只返回分类,不给出结论;若要求给出结论,但无法恢复主张或政策,则应询问,或报告 BLOCKED。缺少必要证据时,问题仍未解决;仅凭空的问题列表无法证明质量。

恰好加载两份参考文件:基准文件,以及一种语体对应的文件。审阅同一文本时,绝不要同时加载两份语体参考文件——它们的规则有意相互矛盾,依据错误语体提出的问题只会造成干扰。

检测语体

阅读足够多的文本,以判断其用途。文档类内容会指导或规定:它会告诉读者某事如何运作或如何操作,其价值在于可供读者遵循。采用人声语调的写作则会说服、叙述或娱乐:它传达某种视角,其价值在于供人阅读。

如果文本确实混合了两种语体——例如以故事开篇的教程,或转为参考资料的产品发布文章——则采用主体部分占主导的语体,用一行说明选择了哪种语体及原因,并注明未应用另一种语体的规则。

如果确实难以判断哪种语体占主导,应说明情况并提问,而不是默默选择。若无法询问,则采用更接近的语体,并在报告开头说明这一假设。明确提供的 register= 参数始终优先,无需解释。

优先级

项目自身的样式表或 AUTHOR_VOICE.md,以及用户在会话或上下文文件中说明的任何规则,在所有语域中都优先于随附的参考资料。审阅前,请先查找这些内容;如果其中的规则与参考资料不同,应以该规则为准,且不应依据参考资料中的版本提出问题——但如果按所采用语域的标准属于严重问题,仍应报告,并注明对应规则。报告中应说明采用了哪项风格规范来源。

报告

每项发现都应包含:

  • 严重程度和规则领域
  • 准确引用的原文及其位置
  • 规则要求什么,以及此处为何不符合要求
  • 具体的修改建议——一行即可解决时给出改写后的整行,否则说明修改方向

按严重程度排序,严重程度相同的按文本中的位置排序。

干净的文本也是有效结果:明确说明文本没有问题,注明采用的语域和参考资料集,然后结束。不要为了显得全面而凑数,提出边缘问题——凭空制造问题会让作者付出不必要的注意力成本。如果文本中多次出现同一种模式,应通过两三个示例和出现次数报告该模式,而不是每次都单独列为一项发现。

如果某条规则是否适用于这段文本取决于主观判断,应在发现中说明这一点,而不要将其判定为缺陷。

范围,以及本技能不处理的内容

本技能会根据请求审阅用户指定的文本,适用于任何语域:它会通读全文,并依据风格标准进行判断。代码变更中的注释或文档段落是否有必要,则是另一个问题,本技能不对此作答。

如果用户在查看报告后要求应用修改,这属于单独的请求,应按常规编辑处理。

评论

支持 Markdown