proofreader¶

Skill 简介¶

在软件开发和技术文档编写过程中，语法错误、风格不一致以及措辞不当等问题常常困扰着开发者。尽管代码本身可能非常严谨，但文档的准确性、可读性和一致性同样重要。Proofreader 是一个专为解决这些问题而设计的 OpenClaw Skill。它通过自动化的方式审查文本内容，捕捉语法错误、拼写错误和标点问题，并确保文档符合指定的风格指南，如美联社（AP）风格、芝加哥手册（Chicago Manual）风格或自定义的内部风格指南。此外，Proofreader 还提供可读性评分，帮助开发者将复杂的专业技术文档转化为更易于普通受众理解的通俗语言。

Proofreader 的核心优势在于它不仅能指出问题，还能提供详细的修改建议和解释。这使得作者在修正文本的同时，能够学习并理解问题所在，从而在未来的写作中避免类似错误。通过这种方式，Proofreader 在提升文档质量的同时，也帮助开发者逐步提高写作水平。

主要功能¶

1. 语法、拼写和标点审查
Proofreader 能够自动扫描文本，识别并标记语法错误、拼写错误和标点使用不当的地方。例如，它可以检测到句子结构中的错误用词、遗漏的逗号或多余的空格等。

2. 风格指南合规性检查
该 Skill 支持多种主流风格指南，如 AP Style 和 Chicago Manual，并允许用户自定义内部风格指南。Proofreader 会根据指定的风格指南检查文本，标记出任何不符合规范的地方，并提供相应的规则引用。例如，它会指出某些术语是否需要大写，或某些特定表达方式是否符合风格指南的要求。

3. 变更跟踪与反馈
Proofreader 提供类似“跟踪更改”的功能，将所有修改建议按严重程度分类，并以易于理解的格式呈现。它不仅显示修改前后的对比，还为每个建议提供详细的解释，帮助用户理解修改的原因和依据。

4. 一致性审计
在处理长篇文档或多个相关文档时，术语、格式和大小写的一致性尤为重要。Proofreader 可以跨多个章节或文档进行一致性审计，识别出术语使用、格式和大小写等方面的不一致之处。例如，它可以检测出“URL”在某些地方被写成“Url”或“url”，并建议统一使用“URL”。

5. 可读性评分与简化建议
Proofreader 包含可读性评分功能，可以评估文本的复杂程度，并提供简化建议。对于面向普通受众的技术文档，该功能尤其有用。它可以帮助开发者将复杂的专业术语和句子结构转化为更通俗易懂的表达方式，同时保持原意不变。

6. 解释与学习支持
每一条修改建议都附带详细的解释，这不仅帮助用户理解当前问题，还提供了学习机会。用户在修正文本的过程中，可以逐步掌握写作规范和技巧，提高自身的写作能力。

使用场景¶

1. 技术文档编写与审校
在软件开发过程中，开发者经常需要编写技术文档，如用户手册、API 文档和设计文档等。Proofreader 可以帮助开发者快速识别并修正文档中的语法和风格问题，确保文档质量。

2. 博客与文章发布
对于技术博客作者和内容创作者，Proofreader 是一个强大的工具。它可以自动审查博客文章和发布内容，确保没有拼写错误、语法错误和风格不一致的问题，从而提升内容的专业性和可读性。

3. 多文档一致性管理
在大型项目中，文档数量众多，术语和格式的一致性管理成为一个难题。Proofreader 可以跨多个文档进行一致性审计，帮助团队保持文档的一致性和规范性。

4. 简化技术文档
对于面向非技术人员的文档，如产品说明和用户指南，Proofreader 的可读性评分和简化建议功能可以帮助开发者将复杂的专业术语和句子结构转化为通俗易懂的语言。

5. 团队协作与知识共享
在团队协作环境中，Proofreader 可以作为知识共享的工具，帮助团队成员统一写作风格和术语使用，提升团队整体文档质量。

如何使用¶

安装与配置¶

创建工作目录并复制 Skill 文件
bash mkdir -p ~/.openclaw/agents/proofreader/agent cp SOUL.md ~/.openclaw/agents/proofreader/agent/
添加 Proofreader 到 OpenClaw
bash openclaw agents add proofreader --workspace ~/.openclaw/agents/proofreader

前置条件¶

已安装 OpenClaw 平台。
具有对工作目录的读写权限。
具备基本的命令行操作知识。

示例¶

示例 1：校对博客文章¶

假设你写了一篇博客文章，并希望使用 Proofreader 进行校对，可以执行以下命令：

openclaw agents run proofreader "Proofread this blog post"

Proofreader 将返回包含语法错误、拼写错误和风格问题的详细报告，并提供修改建议。例如：

1. 语法错误：
   - 原句：The data is stored in they system.
   - 修改：The data is stored in their system.
   - 解释：使用“their”代替“they”以保持主谓一致。

2. 风格问题：
   - 原句：The app is user-friendly and easy to use.
   - 修改：The app is user-friendly.
   - 解释：避免重复表达，“user-friendly”已经包含“easy to use”的意思。

示例 2：检查文档风格合规性¶

如果你想检查文档是否符合 AP Style，可以执行以下命令：

openclaw agents run proofreader "Check this document against AP Style"

Proofreader 将返回所有违反 AP Style 的地方，并提供相应的规则引用。例如：

1. 术语使用：
   - 原句：The company has over 100 employees.
   - 修改：The company has more than 100 employees.
   - 解释：根据 AP Style，“more than”比“over”更常用。

2. 大小写问题：
   - 原句：The President will attend the meeting.
   - 修改：The president will attend the meeting.
   - 解释：根据 AP Style，除非是特定职位名称，否则不使用大写。

总结¶

Proofreader 是一个功能强大的 OpenClaw Skill，专为提升文本质量和写作效率而设计。无论是技术文档编写、博客文章发布，还是多文档一致性管理，Proofreader 都能提供精准的语法、风格和一致性审查，并提供详细的修改建议和解释。对于开发者、作者和团队协作环境中的知识工作者来说，Proofreader 是一个不可或缺的工具。它不仅能帮助用户快速识别并修正文本中的问题，还能通过详细的解释和反馈，提升用户的写作能力和文档质量。

通过使用 Proofreader，开发者可以更专注于核心开发工作，而不必在文档审校上花费过多时间和精力。这不仅提高了工作效率，也确保了文档的准确性和专业性，最终为用户带来更好的阅读体验。

proofreader