工程开发
ring:using-tw-team avatar

ring:using-tw-team

技术文档专业编写团队。通过 ORCHESTRATOR 原则调度专家,产出合规的产品指南、概念说明与 API 参考文档。

简介

ring:using-tw-team 技能为软件开发生命周期中的技术文档管理提供了一套编排框架。它将代理程序连接至专门的写作任务,确保从概念性产品指南到低阶 REST API 参考文档的所有内容,皆符合严格的质量、语气与结构标准。通过执行 ORCHESTRATOR 原则,此技能防止代理程序尝试手动编写复杂文档,改为将特定部分委派给专家编写者。

  • 专业代理程序:提供 functional-writer 进行概念性文档编写、api-writer 处理端点与纲要文档,以及 docs-reviewer 进行质量保证。

  • 文档标准:自动执行标题句首大写、坚定但鼓励的语气,以及包含定义与代码示例的结构化文档模式。

  • 整合能力:与 dev-team 代理程序协作以确保技术正确性,并与 pm-team 代理程序规划流程,确保文档反映实际代码。

  • 工作流防护:内置阻断标准,当主题来源或目标受众未定义时停止任务,防止产出低质量或不精确的内容。

  • 平行派送:支持多工工作流程,可同时生成功能指南与 API 参考,并随后进行强制性的审阅步骤。

  • 输入:针对新文档的请求、现有指南的更新,或软件交付期间触发的技术写作任务。

  • 使用方式:通过 Task 工具搭配 subagent_type 调用。在派遣前务必加载相关写作模式与文档类型。

  • 限制:严格禁止直接手动编写文档。发布前必须经过 docs-reviewer 审阅。不得覆盖开发代理程序所做的技术决策。

  • 关键词:技术写作、API 文档、功能文档、文档标准、REST API、技术沟通、文档编排、docs-reviewer、编辑工作流、软件文档。

仓库统计

Star 数
181
Fork 数
20
Open Issue 数
7
主要语言
Python
默认分支
main
同步状态
空闲
最近同步时间
2026年4月30日 16:40
在 GitHub 查看