Skip to content
Apothem
流水线命令

/docs-review

/docs-review——针对散文约定与十维质量标准的文档审查扫查。

角色: 文档审查者 流水线位置: 堡垒

针对散文约定与十维质量标准的文档审查扫查。

规范调用

/docs-review

带参数:

/docs-review [path/to/repo/ or path/to/docs-source/] [--focus FILE_OR_DIR] [--dry-run]

输入

宿主仓库文档界面

输出

文档发现项位于 _inputs/docs-review-findings.md

下游

审计审查序列的文档审查阶段

工作流阶段

该命令分为五个阶段:输入摄取、逐页遍历、逐项分诊、发现项输出,以及校验门。

失败模式

症状原因恢复
质量门 FAIL输出未达到标准修复输出并重新运行
缺失输入文件该路径下无法访问到任何文档文件传入包含 Markdown 页面的仓库根目录或文档源目录

示例

# Dry-run to preview what would happen
/docs-review --dry-run

# Execute against a repository root
/docs-review path/to/repo/

交叉引用

On this page