跳到正文

文档质量检查工具

使用项目内格式化、链接检查、构建和浏览器预览,并以人工复核确认语义和结果。

从仓库已有工具开始

核对项目脚本和贡献说明,为本次改动选择合适的检查。格式化工具可以统一表格、列表和代码围栏。链接检查能找到失效的目标。站点构建负责发现元数据、组件和内容索引问题。语言检查命中的专名、术语和提示词需要结合上下文确认。

在简中文档站点仓库根目录,可以检查规范文件格式和构建结果。

pnpm exec oxfmt --check content/docs
pnpm run build

格式检查发现差异时,可对本次修改的文件运行格式化,再查看差异。构建通过后用本地预览流程打开页面。

选择适合改动的检查

改动自动检查人工复查
标题、路径或目录路径和锚点检查旧入口的版本、语言与跳转目标
命令或配置运行示例或项目测试前置条件、复制值和预期输出
术语或句式拼写检查和全文搜索语境中术语的真实含义
组件、图片或表格构建和资源检查窄屏、键盘、替代文本与截图状态

记录可复现的检查结果

在 PR 中写明检查命令、版本及实际结果。渲染失败时可以缩到一个页面、一个小节或一段最短语法片段。某个链接因访问权限无法验证时,记录需要用什么环境确认。用审阅清单补足工具无法判断的内容准确性、读者起点和版本范围。