mcpField
L
ln-313-review-docs-worker

ln-313-review-docs-worker

github.com/levnikolaevich开发584105 次安装2 天前更新
代码仓库

关于 ln-313-review-docs-worker

用于根据 Story 需求生成或更新评审所需文档的 Worker Skill。它检测文档模式，将生成的文档链接回 Story，并记录 review-docs 摘要。

主要功能

  1. 01从 Story 提取技术领域
  2. 02依据注册表检测模式
  3. 03生成和更新文档
  4. 04关联 Story 并记录运行时检查点
  5. 05写入 review-docs 摘要并自检

适用场景

  1. 01为 Story 创建缺失文档
  2. 02根据已验证变更更新现有文档
  3. 03计划评审无文档变更时跳过

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/levnikolaevich/claude-code-skills --skill ln-313-review-docs-worker

安装后在 Claude Code 中输入/ln-313-review-docs-worker确认已加载。

包含的文件

除 SKILL.md 外，安装时一起下载的参考资料和脚本。

references/
documentation_creation.md
domain_patterns.md
evaluation_summary_contract.md
evaluation_worker_runtime_contract.md
references/templates/
adr_template.md
guide_template.md
manual_template.md
research_template.md

详细介绍

路径： 文件路径（references/、../ln-*）均相对于此技能目录。

类型： L3 Worker 类别： 3XX 规划

文档审查 Worker

必须阅读

必须阅读： 加载 references/evaluation_worker_runtime_contract.md、references/evaluation_summary_contract.md 必须阅读： 加载 ../ln-310-multi-agent-validator/references/domain_patterns.md

目的

  • 创建缺失的审查必需文档
  • 仅使用已验证的变更更新现有文档
  • 将文档工作与合并和修复分开

模式门控

  • mode=story：完整文档流程——领域提取、模式检测、文档生成
  • mode=plan_review：除非存在文档变更，否则跳过；记录 docs_skipped_reason

运行时

运行时系列：

  • evaluation-worker-runtime

必需清单字段：

  • identifier
  • phase_order
  • summary_kind=review-docs
  • operation=docs

建议的 phase_order：

  1. PHASE_0_CONFIG
  2. PHASE_1_EXTRACT_DOMAINS
  3. PHASE_2_PATTERN_DETECTION
  4. PHASE_3_GENERATE_DOCS
  5. PHASE_4_LINK_TO_STORY
  6. PHASE_5_WRITE_SUMMARY
  7. PHASE_6_SELF_CHECK

工作流

阶段 1：提取领域
  1. 从 Story 标题、技术说明和实施任务中提取技术领域。
  2. 构建范围明确的文档主题列表。
阶段 2：模式检测
  1. 从 domain_patterns.md 加载模式注册表。
  2. 通过关键词检测扫描 Story 内容，查找匹配的模式。
  3. 如果检测到多个模式，则创建所有适用的文档。
阶段 3：生成文档

针对每个检测到的模式：

  1. 检查预期输出路径下是否已有文档（glob docs/{type}s/*{pattern}*.md）。
  2. 如果缺失：从 references/templates/ 加载模板（adr_template.md、guide_template.md、manual_template.md）。
  3. 按照研究方法，使用可用的 MCP 工具研究模式主题。
  4. 对于 ADR 模式：生成前在内部回答 5 个 ADR 问题（背景、决策、后果、备选方案、状态）。
  5. 生成文档。规则：生成的文档中不得包含代码；优先使用表格而非散文；目标长度为 300–500 个词。
  6. 保存到 docs/{type}s/{naming}.md。
阶段 4：关联 Story
  1. 将已创建文档的链接添加到 Story 技术说明中。
  2. 使用 docs_checkpoint 更新运行时状态。
阶段 5：撰写摘要

输出 summary_kind=review-docs。

负载必须包含：

  • worker=ln-313
  • status
  • operation=docs
  • warnings

如有则优先包含以下字段：

  • docs_created（路径列表）
  • docs_updated（路径列表）
  • docs_skipped_reason（适用时）
  • patterns_detected（匹配的模式列表）
阶段 6：自检

后备方案：如果没有匹配的模式，但某个技术方面缺少文档，则按照 domain_patterns.md 中的后备策略使用 MCP Ref。

完成定义

  • 已确定文档目标
  • 已根据 domain_patterns.md 执行模式检测
  • 已应用文档变更，或说明跳过的理由
  • 已撰写 review-docs 摘要
  • 已通过自检

版本： 1.0.0 最后更新： 2026-04-10

评论

支持 Markdown