SuperAPI AI 工具集

docs-parity-reviewer

写作与研究

查看项目

更新于 10-16 04:54

技能介绍

用途:这是 pydantic-ai-harness 的文档门禁技能,在能力相关 PR 合并前使用。每个已发布能力需维护两份手写文档并保持同步:能力目录下的 README(服务于 GitHub 和 PyPI,保留绝对链接与徽章),以及 docs/harness/<capability>.md 统一文档(服务于文档站点,无徽章,可含 ::: pydantic_ai_harness 自动 API 块)。两份文档均需手动维护,只更新其一是需要拦截的失败模式。

主要能力:核对两份文档的更新情况;验证代码片段可解析可运行;检查 README 与统一文档在安装 extras、选项名、默认值、安全提示上是否一致;检查链接规范;检查源模块链接与 API 引用块;检查安全限制说明是否保留;检查写作风格(无 em-dash、无夸张、纯 ASCII 标点);检查开头是否先讲用途;检查文档名与 H1 是否使用能力的描述性名称;检查稳定性措辞。

使用方式:给出变更 diff 或说明;未指明能力时,从当前分支在 src/pydantic_ai_harness/pydantic_ai_harness/ 与 docs/harness/ 下改动的文件推断。先阅读能力源码、README 与统一文档,再逐条报告问题(blocking / warning / nit)并给出具体修复建议。可运行 uv run pytest tests/harness/test_doc_snippets.py 检查解析与 harness 导入。

限制:该脚本本身不编辑文件,仅在发现问题时输出简报。若全部合格,用一行说明。资料未提供该技能的独立安装方式或更多配置细节。