SuperAPI AI 工具集

technical-documentation

写作与研究

查看项目

更新于 10-15 18:37

技能介绍

用途

Technical Documentation 用于产出与审查清晰、可操作、可维护的技术文档,服务的对象既包括人,也包括 AI 智能体。其覆盖范围不仅是常规的产品文档,还包括贡献者治理文件与智能体指令文件。

适用时机

该技能适用于以下情形:

  • 在既有产品或代码库中创建或整体改造文档(brownfield,遗留改造)。
  • 构建旨在长期保持准确、可复用的常青文档(evergreen)。
  • 审查文档差异(diff)的结构、清晰度与操作正确性。
  • 执行全仓库文档审计,且必须同时覆盖治理文件与产品文档表面(如 docs/、README*、.md/.mdx/.mdc,以及 Fern/Sphinx/Mintlify 风格的源文件)。
  • 更新或审查 AGENTS.md 与 CONTRIBUTING.md,使智能体与贡献者工作流与当前仓库实践保持一致。
  • 改进包含贡献说明、issue 模板、PR 流程与评审关卡的仓库上手/文档。
  • 为带有别名指令文件(例如 CLAUDE.md、AGENT.md、.cursorrules、.cursor/rules/*、.agent/、.agents/、.pi/)的仓库设计治理文档策略;当 AGENTS.md 存在时将其视为规范文件,别名则作为兼容表面保留。
  • 诊断智能体文件漂移问题,例如团队不得不反复提示以暴露缺失文件、损坏命令或策略冲突。
  • 应用仓库特定的文档叠加规则,包括在存在时应用 OpenClaw 的页面类型、文档信息架构、保留与校验规则。

工作流程

  1. 对任务分类:构建或审查;判断上下文:遗留改造或常青文档。
  2. 尽早清点完整文档范围(治理 + 产品文档):AGENTS/CONTRIBUTING/别名,以及 docs 目录、框架源文件和根/模块 README。
  3. 检测多语言范围(多种语言的 README/docs),并定义所需的对等程度。
  4. 读取 references/agent-and-contributing.md,获取智能体指令与 CONTRIBUTING.md 的工作流规则(清点、规范/别名映射、双模式平衡、交付标准、优先级/冲突处理)。
  5. 读取 references/principles.md,获取治理规则集(Matt Palmer 与 OpenAI)。
  6. 若为 OpenClaw 文档工作,在构建/审查手册之前先读取 references/openclaw.md。
  7. 构建任务遵循 references/build.md。
  8. 审查任务遵循 references/review.md,并主动发现问题,无需等待反复提示。
  9. 对于复杂或高风险任务(构建或审查),在需要保证信心时,可进行更长、更深、更详尽的调查。
  10. 在可用时,使用子智能体进行有界的并行发现/审查工作,然后合并输出为一份连贯的最终交付物。
  11. 当平台/工具选择会影响建议时,使用 references/tooling.md。
  12. 对治理与文档内容两类表面执行主动问题扫描,并在同一轮中修复高置信度缺陷,除非明确要求仅报告模式。
  13. 在遗留改造模式下,优先与当前文档信息架构、工具和发布状态兼容。
  14. 在常青模式下,优先采用不受时效影响的措辞、更新策略与持久结构。
  15. 返回交付物,以及验证说明、对等状态与剩余缺口。

子智能体编排指引

当仓库庞大或请求的变更集较广时,优先使用子智能体;对于全仓库、多框架或高冲突的工作,默认使用它们。

  • inventory-agent -> agents/inventory-agent.md(快速 / Claude haiku):文件/配置发现、覆盖图与缺失路径检查。
  • governance-agent -> agents/governance-agent.md(思考 / Claude sonnet):AGENTS/CONTRIBUTING/别名优先级、冲突与策略漂移。
  • docs-framework-agent -> agents/docs-framework-agent.md(思考 / Claude sonnet):框架配置、相对路径基准,以及文件路径与 URL 路径的映射检查。
  • synthesis-agent -> agents/synthesis-agent.md(长时 / Claude opus):将子智能体输出合并为一份按优先级排序的修复计划与统一的优先级模型。

输入

  • 文档类型(教程、操作指南、参考、解释)与受众。
  • 文件范围或差异范围。
  • 文档框架/工具约束(Fern、Mintlify、Sphinx 等)。
  • 构建/审查模式与遗留改造/常青意图。
  • 目标智能体与人类兼容性意图。
  • 范围内的文档框架表面(例如 Fern、Sphinx、Mintlify、Markdown/MDX/MDC/RST/RSC 文件)。
  • 期望的调查深度/时间预算(快速通过还是详尽审查)。
  • 执行模式(单智能体,或在可用时由子智能体辅助)。
  • 修复模式(默认应用修复,或在要求时仅报告)。
  • 多语言范围:事实来源语言、目标语言区域与对等期望。
  • 仓库特定叠加约束(如有)。

输出

  • 更新后的草稿或审查发现,并带有明确的后续动作。
  • 验证说明(检查了什么、还剩下什么)。
  • 面向长期质量的导航/维护建议。
  • 当触及 AGENTS/CONTRIBUTING 时的治理文档对齐摘要。
  • 智能体指令表面映射(主文件、别名文件、Codex/Claude/Cursor 处理方案)。
  • 文档表面覆盖图(在 /docs、README 层级结构与框架特定源码树中审查了什么)。
  • 自动检测的问题清单及已应用修复(或明确的仅报告发现)。
  • 使用子智能体时的委派说明(委派了什么范围、发现如何合并)。
  • 多语言对等说明(同步、部分同步并附理由,或有意分歧)。
  • 使用仓库特定叠加时的叠加说明。

限制

除上述资料外,该技能的收费、价格、支持的平台限制与实际使用效果暂未提供。