用途:对文档进行系统性审查,产出分级、可执行的改进建议,并可在用户要求后协助修复。针对 Docus/Nuxt Content 优化,同时兼容任意 Markdown 文档。\n\n主要能力:执行 5 步流程——检测项目类型(Docus/Nuxt Content 还是通用 Markdown)、分析文档结构(目录、语言区域、章节、核心文件)、技术校验、内容质量审查(清晰度、SEO、结构、国际化)、生成报告。问题分为 Critical(阻断部署或引发错误)、Important(显著影响体验/SEO)、Nice-to-have(优化建议)三级。\n\n技术校验(Docus 类):检查 frontmatter(必需 title、description)、MDC 组件语法(Nuxt UI 组件须带 u- 前缀,如 ::u-page-hero)、代码块文件标签、代码语言与项目技术栈一致、包管理器覆盖、代码预览与分组范围、文件命名(编号目录、kebab-case、.navigation.yml)、隐藏页面设置。常见错误包括缺少 u- 前缀、缺少必需 frontmatter、.navigation.yml 结构异常、章节缺少 index.md 导致 404。\n\n内容质量审查(所有类型):检查主动语态、句式与段落长度、动作型标题、术语一致性、代码示例可复制性;SEO 方面检查标题 50-60 字符、描述 120-160 字符、标题层级、URL、链接、内容长度、图片替代文本;结构方面检查层级深度、每节页数、导航文件、流程连贯性;多语言项目检查各语言目录与文件对应、翻译完整度、导航一致性。\n\n通用 Markdown 项目仅做基础校验:常用 frontmatter 字段、标准 Markdown 语法、内部链接与图片路径,不做 Docus 专属检查,重点放在内容质量。\n\n输出:生成详细审查报告(含执行摘要、按类别分级的问题、文件路径与行号、修改前后对比、影响说明、统计表、亮点与优先行动计划),仅生成报告;如用户要求可进一步修复问题。\n\n限制:资料未提供具体安装命令、收费方式、支持的平台或运行环境要求。
review-docs
写作与研究
更新于 10-15 16:44