doc_quality_check 是做什么的?
来自DanhDue/ai-agent-tools的Agent技能「doc_quality_check」。
该技能专为AI代理(如Claude Code、Cursor、Codex等)设计,用于自动检查技术文档的质量。它通过以下方式工作:
- 语法检查:发现拼写错误、语法问题和不规范的标点符号使用。
- 风格一致性:确保术语、标题和格式风格统一。
- 可读性分析:评估句子长度、复杂度和整体可读性。
- 链接验证:检查内部和外部链接的有效性。
- 一致性检查:比较多个文档中的术语和用法。
该技能可以集成到CI/CD管道中,作为文档发布前的质量门禁。它支持多种输出格式,包括JSON和Markdown报告,便于在自动化工作流中使用。
使用示例
- 在CI配置中添加该技能作为步骤。
- 将技能指向文档目录。
- 根据生成的报告做出修改或修复。
支持的平台
- Claude Code
- Cursor
- Codex
- 其他兼容的AI代理
更多详细信息,请参考原始仓库。