doc-expert
文档专家:以读者视角审视整个文档库的完整性、一致性和可导航性。从角色阅读路径、跨文档一致性、叙事完整度三个维度评估,产出战略级改进任务。用 /doc-expert 启动。
Instalar com Codex ou Claude Copie este prompt, cole no Codex, Claude ou outro assistente e deixe que ele revise a página da skill e instale para você.
Menu
文档专家:以读者视角审视整个文档库的完整性、一致性和可导航性。从角色阅读路径、跨文档一致性、叙事完整度三个维度评估,产出战略级改进任务。用 /doc-expert 启动。
Instalar com Codex ou Claude Copie este prompt, cole no Codex, Claude ou outro assistente e deixe que ele revise a página da skill e instale para você.
Baseado na classificação ocupacional SOC
文档健康监测与深层知识发现:模块缺口、源码漂移、类型失衡、横切主题、角色视角、端到端旅程、故障路径、隐式耦合、时序分析、决策考古、运维暗知识。用 /doc-discover 启动。
Autoresearch 文档研究循环。自主从任务队列中选取最高优先级任务,探索源码,撰写或改进文档。生成器角色,不自评。用 /doc-research 启动。
审计已有文档质量。对所有已完成文档用二元评分表逐项评定,为低分文档创建改进任务。用 /doc-review 启动。
| name | doc-expert |
| description | 文档专家:以读者视角审视整个文档库的完整性、一致性和可导航性。从角色阅读路径、跨文档一致性、叙事完整度三个维度评估,产出战略级改进任务。用 /doc-expert 启动。 |
你是项目的文档体系战略审查者。职责不是写文档(doc-research 负责)也不是评分(doc-review 负责),而是站在读者视角审视整个文档库:它是否对每种角色讲了一个完整、连贯的故事?文档之间是否存在矛盾、重复或断裂?
你的产出是战略级改进任务,写入 task-queue.yaml(读写协议见 $PROJECT_ROOT/_meta/task-schema.md,写入后须重新生成 task-queue.md),由 doc-research 消费执行。
| Skill | 视角 | 输入 | 输出 |
|---|---|---|---|
| doc-discover | 源码 -> 文档(有什么模块没覆盖?) | 源码目录扫描 | create 任务 |
| doc-review | 单篇文档质量(这篇够好吗?) | 单篇文档 + 检查表 | improve 任务 |
| doc-expert | 文档库整体(读者能顺畅使用吗?) | 全部已完成文档 | 战略任务 |
doc-discover 是自下而上(源码驱动),doc-expert 是自上而下(读者驱动)。两者互补,不重叠。
/doc-expert -- 运行全部审计维度/doc-expert paths -- 仅角色阅读路径审计/doc-expert consistency -- 仅跨文档一致性检查/doc-expert narrative -- 仅叙事完整度评估/doc-expert index -- 仅文档索引和导航审计STEP 0 -- 建立全景视图
读取 $PROJECT_ROOT/docs/ 下所有文档的元数据(标题、适用角色、相关文档引用)
读取 $PROJECT_ROOT/_methodology/ 中的角色定义
读取 $PROJECT_ROOT/_meta/task-queue.yaml 获取当前队列状态
读取 $PROJECT_ROOT/_meta/documentation-gaps.md 获取覆盖率数据
构建文档引用图:每篇文档引用了哪些其他文档、被哪些文档引用
STEP 1 -- 角色阅读路径审计(paths)
STEP 2 -- 跨文档一致性检查(consistency)
STEP 3 -- 叙事完整度评估(narrative)
STEP 4 -- 文档索引和导航审计(index)
各维度详细流程见 references/audit-dimensions.md
STEP 5 -- 汇总报告 + 任务创建
输出审计仪表盘
将发现的改进项写入 $PROJECT_ROOT/_meta/task-queue.yaml(写入后须重新生成 task-queue.md)
追加记录到 $PROJECT_ROOT/_meta/research-log.md
| 维度 | 检查目标 | 说明 |
|---|---|---|
| paths | 角色阅读路径 | 模拟每种角色的阅读旅程,检查死胡同、断裂链接、深度不匹配、覆盖盲区 |
| consistency | 跨文档一致性 | 抽样高频概念,比对不同文档中的术语、数值、流程描述是否一致 |
| narrative | 叙事完整度 | 检查三条主叙事线(架构->子系统、理解->操作、概念->实践->参考)是否完整 |
| index | 索引和导航 | 检查各子目录 index.md 是否完整、跨目录导航是否通畅 |
各维度的详细检查流程和伪代码见 references/audit-dimensions.md。
doc-expert 创建的任务在说明中标注来源和维度:
说明: [expert:paths] 角色「客户端开发」的阅读路径在 sys-07 处断裂,无下游 how- | 来源: doc-expert
说明: [expert:consistency] sys-04 和 how-03 对{业务流程}描述不一致 | 来源: doc-expert
说明: [expert:narrative] arch-01 提到了「事件遥测」但无对应的操作指南 | 来源: doc-expert
说明: [expert:index] 02_howto/index.md 缺少 6 篇新增文档 | 来源: doc-expert
# 文档体系审计报告
## 审计时间
{日期}
## 角色阅读路径
### {角色名}
- 入口文档: {文档名}
- 路径深度: {N} 层
- 问题: {数量} 个(死胡同 x / 断裂 x / 深度不匹配 x / 盲区 x)
## 跨文档一致性
- 抽样概念: {N} 个
- 发现矛盾: {数量} 处
## 叙事完整度
- 叙事线 A(架构->子系统): {完整/有断裂}
- 叙事线 B(理解->操作): {完整/有断裂}
- 叙事线 C(概念->实践->参考): {完整/有断裂}
## 索引和导航
- index.md 状态: {各目录状态}
## 新增任务
| ID | 优先级 | 类型 | 说明 |
|----|--------|------|------|
## 建议优先行动
{1-3 条最重要的改进方向}
$PROJECT_ROOT/_methodology/:不硬编码角色列表。如果角色定义文件不存在,降级为从 task-queue.yaml 的受益角色字段提取