Agent skill

document-quality

多维度审查 Markdown 文档质量，覆盖结构、内容、格式、引用、元数据五大维度。当需要评审文档质量、统一格式规范、验收交付文档时使用。提供分级检查清单、通过标准、常见问题修复指南，支持从快速检查到深度审计的多层次需求。

View SKILL.md on GitHub Repository
Stars 5
Forks 1

Install this agent skill to your Project

npx add-skill https://github.com/tikazyq/agentic-spec-forge/tree/main/AGENTIC_SPEC_FORGE/spec_stage_skill/common_normal/document-quality

SKILL.md

Document Quality Skill

Scope: COMMON（全阶段通用）

版本: 0.1.0（占位）| 创建日期: 2025-11-27

概述

多维度文档质量检查：

  • 结构维度: 标题层级、章节完整性
  • 内容维度: 清晰度、准确性、一致性
  • 格式维度: Markdown 规范、表格对齐
  • 引用维度: 链接有效性、交叉引用完整
  • 元数据维度: 版本号、日期、作者

L1-STREAMLINED

检查清单

  • 标题层级正确（H1 唯一，H2-H4 递进）
  • 无孤立链接（所有引用可访问）
  • 版本号和日期存在
  • 无明显拼写错误

通过标准

  • 4 项中 3 项通过（≥75%）

L2-BALANCED

检查清单（包含 L1）

  • L1 全部检查项
  • 表格格式对齐
  • 代码块有语言标注
  • 段落长度适中（无超长段落）
  • 术语使用一致

通过标准

  • 9 项中 8 项通过（≥90%）

L3-RIGOROUS

检查清单（包含 L1/L2）

  • L1/L2 全部检查项
  • 交叉引用完整（双向链接）
  • 无重复内容（DRY 原则）
  • 可访问性（图片有 alt text）
  • 国际化考虑（中英文混排规范）
  • SEO 友好（标题含关键词）

通过标准

  • 15 项中 14 项通过（≥95%）

>> 命令

>>doc_check_l1         # L1 快速检查
>>doc_check_l2         # L2 标准检查
>>doc_check_l3         # L3 严格检查
>>doc_fix              # 自动修复常见问题

相关 Skills

  • 原则: principle-dry（文档避免重复）
  • 应用: draft-finalize（需求文档定稿前检查）
  • 应用: all design SKILLs（设计文档质量检查）
  • 所有阶段: 通用文档质量门

TODO: 待细化检查规则和自动修复脚本

Recommended Agent Skills

Expand your agent's capabilities with these related and highly-rated skills.

tikazyq/agentic-spec-forge

code-review

执行代码审查流程（提交PR→自查→同行审查→反馈修改→合并），覆盖功能正确性、代码质量、测试完整性、安全合规四大维度。当提交Pull Request、进行结对编程、执行代码走查、需要知识共享时使用。支持L1/L2/L3三级审查深度。

5 1
Explore
tikazyq/agentic-spec-forge

code-quality

执行代码质量门禁检查（测试通过→覆盖率→Lint→GOAL追溯→可提交），验证单元测试覆盖率≥80%、集成测试通过率≥95%、代码规范零错误。当完成代码实现、准备提交代码、需要质量验证、进行提交前自检时使用。确保代码可合并。

5 1
Explore
tikazyq/agentic-spec-forge

tdd-cycle

执行 TDD 红绿重构循环（RED→GREEN→REFACTOR→REPEAT），通过先写失败测试、最小代码实现、保持绿色重构的节奏驱动开发。当启动功能开发、需要测试驱动节奏、进行迭代编码、追求高测试覆盖率时使用。提供检查清单和节奏控制。

5 1
Explore
tikazyq/agentic-spec-forge

refactoring

执行代码重构（识别坏味道→选择手法→小步修改→运行测试），在保持外部行为不变前提下改进内部结构。当TDD进入REFACTOR阶段、发现代码坏味道、需要消除重复代码、优化代码结构时使用。支持提取方法、类、参数对象等重构手法。

5 1
Explore
tikazyq/agentic-spec-forge

arch-options-compare

比较多个架构方案（单体/微服务等），从SOLID原则、成本、复杂度等维度评分，生成对比表和推荐方案。当需要向客户解释架构选择或ADR决策时使用。

5 1
Explore
tikazyq/agentic-spec-forge

dev-tech-view-supplement

根据设计补充Dev视角的技术细节（数据库/API/通信协议），帮助Dev快速进入实施。当L1/L2设计缺乏技术细节、或准备向Dev交付前使用。

5 1
Explore

Didn't find tool you were looking for?

Be as detailed as possible for better results