Community编程与开发github.com

DanhDue/doc_quality_check

Agent技能「文档质量检查」来自DanhDue/ai-agent-tools。

doc_quality_check 是什么?

DanhDue/doc_quality_check 是一个为AI代理(如Claude Code、Cursor等)设计的技能,旨在自动检查文档质量。它通过分析文档的语法、风格、可读性和一致性,帮助开发者和技术写作者维护高质量的文档。该技能支持常见的技术文档格式(如Markdown、reStructuredText等),并能够集成到CI/CD管道中,以确保持续的文档质量。它将文档拆分为可处理的块,应用一系列预定义或自定义的检查规则,并生成详细的质量报告。这个技能特别适合用于开源项目、API文档和内部知识库的质量保证,能够显著减少人工审查的工作量,提高文档的准确性和可维护性。

兼容平台~Claude Code~Codex CLI~Cursor
npx skills add https://github.com/DanhDue/ai-agent-tools/tree/main/skills/doc_quality_check

Installed? Explore more 编程与开发 skills: steipete/bluebubbles, steipete/eightctl, steipete/blucli · View all 6 →

在你喜欢的 AI 中提问

打开一个已预加载此 Agent Skill 的新对话。

文档

doc_quality_check 是做什么的?

来自DanhDue/ai-agent-tools的Agent技能「doc_quality_check」。

该技能专为AI代理(如Claude Code、Cursor、Codex等)设计,用于自动检查技术文档的质量。它通过以下方式工作:

  • 语法检查:发现拼写错误、语法问题和不规范的标点符号使用。
  • 风格一致性:确保术语、标题和格式风格统一。
  • 可读性分析:评估句子长度、复杂度和整体可读性。
  • 链接验证:检查内部和外部链接的有效性。
  • 一致性检查:比较多个文档中的术语和用法。

该技能可以集成到CI/CD管道中,作为文档发布前的质量门禁。它支持多种输出格式,包括JSON和Markdown报告,便于在自动化工作流中使用。

使用示例

  1. 在CI配置中添加该技能作为步骤。
  2. 将技能指向文档目录。
  3. 根据生成的报告做出修改或修复。

支持的平台

  • Claude Code
  • Cursor
  • Codex
  • 其他兼容的AI代理

更多详细信息,请参考原始仓库。

Individual skills in this repo

This repo contains 20 individual skills — each has its own dedicated page.

DanhDue/android-api-integration

Agent skill 'android-api-integration' from DanhDue/ai-agent-tools.

DanhDue/android-ui-audit

Agent skill 'android-ui-audit' from DanhDue/ai-agent-tools.

DanhDue/api_integration

Agent skill 'api_integration' from DanhDue/ai-agent-tools.

DanhDue/architecture-audit

Agent skill 'architecture-audit' from DanhDue/ai-agent-tools.

DanhDue/brainstorming

Agent skill 'brainstorming' from DanhDue/ai-agent-tools.

DanhDue/build_fix

Agent skill 'build_fix' from DanhDue/ai-agent-tools.

DanhDue/check_secure_files

Agent skill 'check_secure_files' from DanhDue/ai-agent-tools.

DanhDue/code-health-audit

Agent skill 'code-health-audit' from DanhDue/ai-agent-tools.

DanhDue/copy_secure_configurations

Agent skill 'copy_secure_configurations' from DanhDue/ai-agent-tools.

DanhDue/create_new_feature

Agent skill 'create_new_feature' from DanhDue/ai-agent-tools.

DanhDue/decision-records

Agent skill 'decision-records' from DanhDue/ai-agent-tools.

DanhDue/dev-brainstorming

Agent skill 'dev-brainstorming' from DanhDue/ai-agent-tools.

DanhDue/dev-designer

Agent skill 'dev-designer' from DanhDue/ai-agent-tools.

DanhDue/dev-implementation

Agent skill 'dev-implementation' from DanhDue/ai-agent-tools.

DanhDue/dev-lifecycle

Agent skill 'dev-lifecycle' from DanhDue/ai-agent-tools.

DanhDue/dispatching-parallel-agents

Agent skill 'dispatching-parallel-agents' from DanhDue/ai-agent-tools.

DanhDue/doc-brainstorming

Agent skill 'doc-brainstorming' from DanhDue/ai-agent-tools.

DanhDue/doc-designer

Agent skill 'doc-designer' from DanhDue/ai-agent-tools.

DanhDue/doc-implementation

Agent skill 'doc-implementation' from DanhDue/ai-agent-tools.

DanhDue/doc-lifecycle

Agent skill 'doc-lifecycle' from DanhDue/ai-agent-tools.

相关技能