shield_lock
JinDaGe
← Back to skills
extension
Category: Development & EngineeringNo API key required

document-quality

Conduct a multi-dimensional review of the quality of Markdown documents, covering five major dimensions: structure, content, format, references, and metadata. It is used when there is a need to evaluate document quality, unify formatting standards, and accept delivery documents. It provides tiered checklists, passing criteria, and a guide for fixing common issues, supporting a range of needs from quick checks to in-depth audits.

personAuthor: jakexiaohubgithub
open_in_newRepositorydownloadDownload package

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: 待细化检查规则和自动修复脚本