ARTICLE DETAIL

资讯详情

深耕网站建设与运营推广的一线实战洞察。

Strands SDK 文档审查技能:docs-reviewer 如何把关 Voice、结构与术语质量

Strands SDK 文档审查技能:docs-reviewer 如何把关 Voice、结构与术语质量 人工智能大模型AI AgentAgent 框架多智能体工具调用MCP 服务【免费下载链接】harness-sdkBuild an agent harness and control it end-to-end. Open-source SDK for production AI agents in Python TypeScript - any model, any cloud.项目地址https://gitcode.com/GitHub_Trending/sdkpython13/harness-sdk点击查看免费下载导读本文讲解 harness-sdk 仓库中内置的docs-reviewerAgent 技能一套面向文档草稿的六维审查框架从 Voice 一致性、多语言正确性、术语锁定、代码示例完整性到人机可读性逐项打分并输出 Ship it / Tighten / Rethink 三级判定。读完本文你将掌握这套审查体系的全部分工、评分维度、判定规则与输出格式并了解它在 Strands SDK 文档生产流水线docs-planner → docs-writer → docs-reviewer → docs-audit中的位置可直接用于自检自己的文档草稿。技能定位它不是技术审计而是发布前的 Voice 与结构关卡docs-reviewer是仓库.agents/skills/下的一套 Agent 技能skill其定义文件位于 .agents/skills/docs-reviewer/SKILL.md。技能文件的 frontmatter 明确了触发条件在草稿完成之后、提交 PR 之前或在docs-writer产出内容之后自动运行用户说 review this draft、check my docs、is this ready to ship、review before merging 时也会触发。它审查的对象是进行中的草稿范围锁定在 Voice语气、结构、术语三个层面。技能开头划出了一条关键边界线bright line审查者不校验技术准确性不核对 import 路径是否指向真实 SDK 模块、方法签名是否匹配当前 SDK 版本那是docs-audit的职责。代码示例只做结构完整性检查import 是否齐全、变量是否定义、取值是否真实、有没有foo/bar这类占位符即 Stripe 完整性原则属于 Voice/风格检查。这条分工在技能目录中得到了呼应docs-audit技能明确写着 The SDK source is the source of truth负责对照源码验证准确性而docs-reviewer只回答草稿是否做好了发布的准备。两个技能一前一后构成文档质量的两个独立关卡。五步审查流程技能定义的 Procedure 是五步读取用户提供的草稿根据 frontmatter 或结构对内容类型分类tutorial、how-to、explanation、reference对下方六个维度逐项打分给出唯一判定verdict输出结构化审查报告。第 2 步的分类不是走过场。内容类型决定了后续很多约束的松紧教程允许使用 Now lets... 之类的口吻参考文档允许被动语态解释型文章允许更长的句子。分类错了后面的打分基准就错了。六维审查框架维度一Voice Stack ComplianceVoice 栈合规此维度要求审查者对照仓库中的五层 Voice 栈定义见 .agents/references/voice-guide.md逐层核查Structure每个小节是否只回答一个问题。混用目的的小节会被标记。Narrative flow是否先讲清主题为什么重要、解决什么使用场景问题再用 Strands SDK 以自包含、简洁的方式展示实现。Framing每个小节的第一句是否描述开发者的目标而不是 API 的能力。以 API 描述开头的小节会被标记。voice-guide 中给出了正反例You create an agent with custom tools by passing them to the constructor. 是通过标准而 The Agent class accepts a tools parameter in its constructor. 是参考文档式的写法。Register语气是否与内容类型匹配。Constraints扫描禁用短语、em-dash破折号、被动语态、含糊措辞并按类型感知的覆盖表type-aware overrides处理例外参考文档允许被动语态、解释型文章允许最长 40 词的句子。Authenticity结构是否多样、是否存在可见的编辑判断、是否足够凝练。voice-guide 中有一张严格的类型感知约束覆盖表被动语态、30/40 词句长限制、More You Than I 框架、缩写、禁含糊措辞这五项约束在不同内容类型下有不同松紧度。审查者遇到 Vale 标记的被动语态时必须先判定页面类型再决定是真问题还是误报。维度二Multi-Language Correctness多语言正确性Strands SDK 同时提供 Python 与 TypeScript 两个 SDK多数概念页用Tabs双语言展示。审查要点Tab 之间的散文必须语言中立如果 Python 页签内写了 Python requires... 这类点明语言身份的句子会被标记因为读者选择了页签不需要被告知。共享散文中的语言特定标识符应使用Syntax组件自适应读者选择而不是在正文里手工拼写两种写法。标题描述概念而非 API标题中出现语言特定的参数名或语法如preserve_contextFalse或preserveContext: false会被标记。两语言的目录应该读起来完全一致。Callout 框:::note、:::caution等要符合 .agents/references/mdx-authoring.md 定义的标准且大多数事实应以行内散文呈现而非塞进 callout。mdx-authoring.md 补充了实现层面的约定Tabs/Tab与Syntax是全局自动导入组件无需 import两语言的头部结构必须对称任何只存在于单语言的标题都会在另一语言的目录里产生空桩。维度三Terminology Consistency术语一致性此维度对照 .agents/references/terminology.md 的术语锁定表terminology lock逐项核对每个技术术语。任何非规范同义词都会被标记。该文件的核心原则是一个概念一个术语。例如agent loop而非 reasoning cycle、tool calling而非 function calling、tools而非 functions、hooks而非 middleware/callbacks、structured output而非 typed output。术语锁还覆盖基础设施命名Amazon Bedrock而非 AWS Bedrock、Claude而非 Anthropic model等。术语不一致之所以是硬伤是因为 AI 中介Cursor docs、Copilot 等会依据术语之间的关联做推断同一概念的多套叫法会让 AI 生成的代码建议产生混淆。维度四Code Example Quality代码示例质量对每个代码块执行如下检查结构完整Stripe 原则import 齐全、变量已定义、可直接复制运行无需四处寻找上下文。自解释Deno 原则脱离周围散文也能看懂注释解释意图intent而非机制mechanics。变量命名自文档化且简洁不允许foo、bar、my_var。聚焦单一概念。非确定性输出标注 Typical outputAgent 行为不可完全复现确定性代码照原样展示非确定部分必须显式标注。声明与示例对等claim parity散文或注释声称的能力必须由代码演示。技能文档特别强调Type-correct snippets that dont back their claims slip past typecheck and erode trust faster than missing examples.通过类型检查但与声明不符的片段比缺失示例更快侵蚀信任。站点构建约定见 mdx-authoring.md也在本维度内TypeScript 代码必须通过--8--从同级.ts片段文件引入绝不能内联在 MDX 中每个 TypeScript 代码栅栏要同时包含 imports 片段与主体片段Python 代码可以内联图表使用栅栏禁止 ASCII art 或制表符画图。voice-guide 给出了非确定性输出的四种标注模式模型输出在代码下方以注释形式附 Typical output:工具选择用能力语言can use而非确定性语言will call多步推理展示一条代表性的有序 trace结构化输出中 schema 作为确定性代码展示、示例值放在相邻独立块。维度五HumanAI Readability人机可读性文档现在同时面向两类读者直接阅读的人类开发者和通过 AI 中介获取内容的助手。自包含self-contained是核心页面顶部第一段说明覆盖内容不假设读者从其他页面跳转而来前置条件显式声明不沿用前文的隐式假设不存在承重的前后引用前向/后向引用不能是唯一理解途径关键术语首次出现时定义或链接代码示例自包含含 import 与 setup行内代码用反引号正确格式化页面既能被搜索而来的人类独立阅读也能被 AI 助手独立解析。维度六Content Type Alignment内容类型对齐结构是否符合 voice-guide 对该类型的规范信息是否放在正确的位置how-to 指南中不应出现概念背景交叉引用指向正确的类型how-to 链接到 reference 获取细节而不是重复内容。这一维度与 docs-planner 技能中的 Diataxis 完整性检查呼应每个功能区域都应同时具备 tutorial、how-to、reference、explanation 四种类型缺一即视为文档缺口。判定系统Ship it / Tighten / Rethink打完分后必须给出且只给一个判定Ship it所有维度表现良好至多一个带措辞建议的 warning零失败项零术语违规代码示例结构完整可以交给人审阅。Tighten出现两个或以上 warning或一个无需重构即可修复的失败项。典型触发Voice 语境串味、3 处以上术语偏差、冗长超过 40%、缺少 typical output 标注、结构千篇一律看不到编辑判断。要求给出逐行修复建议作者修改后重新提交。Rethink两个或以上失败项或任何结构性失败内容类型错误、混用目的的小节需要重新规划大纲、根本性框架倒置通篇 API-first、缺少前置条件导致读者无法跟上。提供诊断与正确方向作者需要先重新规划大纲再重写。升级规则Escalation rule在 Tighten 与 Rethink 之间犹豫时用一句自问来裁决Can the writer fix this by editing in place, or do they need to re-outline? 原地编辑能修好就是 Tighten需要重新规划大纲就是 Rethink。结构化输出格式技能规定审查报告必须输出为如下固定结构## Review: [Draft Title] **Content type:** [classified type] **Verdict:** Ship it / Tighten / Rethink ### Dimension Scores | Dimension | Score | Key Finding | |-----------|-------|-------------| | Voice stack | ... | ... | | Multi-language | ... | ... | | Terminology | ... | ... | | Code examples | ... | ... | | AI-readability | ... | ... | | Type alignment | ... | ... | ### Specific Findings [numbered list with line references and suggested fixes] ### What Works Well [2-3 things the draft does right]注意原文档标题写的是 Five Review Dimensions五个维度实际列出的维度是六个Voice 栈、多语言、术语、代码示例、人机可读性、内容类型对齐。审查时以实际执行的六个维度为准输出表格中六行全部填写。审查者的边界What You Do NOT Do技能明确划定了审查者的行为禁区不编辑文件只做审查不提交commit、不推送push、不创建 PR不批准或合并判定仅具建议性质不重写章节只提供诊断修复由作者完成不验证 SDK 准确性import 路径、方法签名、API 正确性那是 docs-audit 的职责。这些边界与仓库中其他技能的分工一致.agents/skills/README.md中列出了完整技能矩阵——pr-writer/pr-create/pr-feedback处理 PR 工作流docs-writer起草、docs-reviewer审查、docs-audit审计已发布页面、docs-planner规划文档缺口strands-review本地预演远程审查pre-push镜像 CI 合并门禁。docs-reviewer 是这一流水线中发布前最后一公里的守门员。Review Log跨审查的模式追踪可选技能允许将历史审查记录追加到.agents/review-log.md字段包括日期、草稿标题、内容类型、判定、各维度分数、反复出现的模式recurring patterns、术语决策。这使审查体系具备自我学习能力反复出现的同类型问题可以在下一次审查中优先排查术语决策记录可以沉淀为团队的隐性知识。与审查配套的仓库证据链如果你要亲自把 docs-reviewer 跑起来或者想理解它背后引用的规则仓库中有完整的配套材料.agents/references/voice-guide.md五层 Voice 栈的完整定义含类型感知约束覆盖表、禁用短语清单、非确定性输出标注模式、自包含检查清单.agents/references/terminology.md术语锁定表含核心 SDK 概念、基础设施命名、模型提供者命名、Python/TypeScript 命名分歧.agents/references/mdx-authoring.mdMDX 写作约定含 Tabs/Syntax 用法、TypeScript 片段引入规范、Callout 语法、frontmatter schema.agents/references/code-verification.md四层代码验证流程——本地 SDK 克隆site/.build/sdk-python/与site/.build/sdk-typescript/、GitHub API、已安装包内省、无法验证时停止并上报。如果你需要先写出草稿再交给 docs-reviewer可以并行参考 .agents/skills/docs-writer/SKILL.md 的七步写作流程它本身就以最后运行 docs-reviewer 并处理所有发现作为收尾步骤文档站点的导航结构与页面组织可以在 site/src/config/navigation.yml 中查看。这套体系的最终目的正如 voice-guide 所说让每一页文档既能被搜索引擎与 AI 助手准确解析也能让人类开发者放心复制其中的代码。docs-reviewer 提供的不是一份情绪化的还不错而是一份可逐条执行、可追溯、可复现的结构化诊断。赞分享人工智能大模型AI AgentAgent 框架多智能体工具调用MCP 服务【免费下载链接】harness-sdkBuild an agent harness and control it end-to-end. Open-source SDK for production AI agents in Python TypeScript - any model, any cloud.项目地址https://gitcode.com/GitHub_Trending/sdkpython13/harness-sdk点击查看免费下载相关推荐harness-sdk 文档写作全流程用 docs-writer 技能与五层语音栈产出高质量 Strands 文档harness sdk 文档写作全流程用 docs writer 技能与五层语音栈产出高质量 Strands 文档 本篇指南讲解 harness sdk ht人工智能大模型AI AgentAgent 框架多智能体工具调用MCP 服务harness-sdk strands-review 技能全解析用 Task Reviewer SOP 在本地预演 /strands review 的代码审查harness sdk strands review 技能全解析用 Task Reviewer SOP 在本地预演 /strands review 的代码审查人工智能大模型AI AgentAgent 框架多智能体工具调用MCP 服务NBoost安全部署Kubernetes环境下的权限控制与网络隔离策略NBoost安全部署Kubernetes环境下的权限控制与网络隔离策略 NBoost作为一款基于Transformer模型的搜索结果优化平台在Kuberne上一篇Windows 11任务栏时钟自定义工具ElevenClock安装与配置指南下一篇AnythingSlider终极jQuery轮播插件完全指南创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考
返回列表